Support for development in Docker #4478
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sidharthv96
requested changes
Jun 12, 2023
sidharthv96
reviewed
Jun 12, 2023
There was a problem hiding this comment.
Thanks for the changes @nirname, this would streamline the DX for people using docker :)
nirname
force-pushed
the
feature/docker-development-support
branch
2 times, most recently
from
1e36e48
to
62db4eb
Compare
Updated lintignore and move dockerfile to .dev Fix Updated contributing Fixing GA Fix contributing.md Fixing issues after review No need to change .eslintignore
nirname
force-pushed
the
feature/docker-development-support
branch
from
62db4eb
to
cdea0ea
Compare
sidharthv96
reviewed
Jun 13, 2023
Comment on lines
+17
to
+21
| $RUN mermaid sh -c "npx pnpm test" | ||
| ;; | ||
|
|
||
| lint) | ||
| $RUN mermaid sh -c "npx pnpm -w run lint:fix" |
There was a problem hiding this comment.
Do we need npx after the first install?
There was a problem hiding this comment.
No, that is up to developer. Making a statement that we need this after first install was my fault. Right now, this is simply a script, which is optional to use. No other instructions on that point in CONTRIBUTING.md either, you may run this locally if needed, but that is not a requirement. I simply leave a shortcut command there.
|
@nirname, Thank you for the contribution! |
github-merge-queue bot
pushed a commit
to fuxingloh/contented
that referenced
this pull request
Jul 2, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [mermaid](https://github.com/mermaid-js/mermaid) | [`10.2.3` -> `10.2.4`](https://renovatebot.com/diffs/npm/mermaid/10.2.3/10.2.4) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>mermaid-js/mermaid (mermaid)</summary> ### [`v10.2.4`](https://github.com/mermaid-js/mermaid/releases/tag/v10.2.4): 10.2.4 [Compare Source](https://github.com/mermaid-js/mermaid/compare/v10.2.3...v10.2.4) #### Features - Add Plausible analytics to mermaid.js.org by [@​sidharthv96](https://github.com/sidharthv96) in [mermaid-js/mermaid#4473 - Support for development in Docker by [@​nirname](https://github.com/nirname) in [mermaid-js/mermaid#4478 - standardize info diagram definitions by [@​Yokozuna59](https://github.com/Yokozuna59) in [mermaid-js/mermaid#4486 - Change C4 stereotype braces from ASCII <\</>> to Unicode «/» by [@​jonathan-r-young](https://github.com/jonathan-r-young) in [mermaid-js/mermaid#4460 - Add coverage for E2E tests by [@​sidharthv96](https://github.com/sidharthv96) in [mermaid-js/mermaid#4498 - set normal mode for vitest coverage by [@​Yokozuna59](https://github.com/Yokozuna59) in [mermaid-js/mermaid#4505 - Use v8 coverage in vitest by [@​sidharthv96](https://github.com/sidharthv96) in [mermaid-js/mermaid#4560 - feat(flowchart): add classDef style group definition by [@​tomperr](https://github.com/tomperr) in [mermaid-js/mermaid#3923 - add cypress coverage clean by [@​Yokozuna59](https://github.com/Yokozuna59) in [mermaid-js/mermaid#4556 - fix(class): keep members in namespace classes by [@​tomperr](https://github.com/tomperr) in [mermaid-js/mermaid#4532 #### Bugfixes - Add hint on "flowchart" and "graph" by [@​koppor](https://github.com/koppor) in [mermaid-js/mermaid#4096 - fix(flowchart): apply style on doublecircle by [@​tomperr](https://github.com/tomperr) in [mermaid-js/mermaid#4540 - fix not rendered style when style is optional by [@​Yokozuna59](https://github.com/Yokozuna59) in [mermaid-js/mermaid#4528 - fix(flowchart): allow multiple vertices with style by [@​tomperr](https://github.com/tomperr) in [mermaid-js/mermaid#4553 #### Documentation - change REAMDME.md coverage from coveralls into codecov by [@​Yokozuna59](https://github.com/Yokozuna59) in [mermaid-js/mermaid#4507 - Update latest news section by [@​huynhicode](https://github.com/huynhicode) in [mermaid-js/mermaid#4468 - Fix link to Tutorials from n00b-overview page by [@​Spiderpig86](https://github.com/Spiderpig86) in [mermaid-js/mermaid#4472 - Fix Directives Documentation by [@​adamazing](https://github.com/adamazing) in [mermaid-js/mermaid#4475 - Correct "Bronze" spelling in timeline docs by [@​adamazing](https://github.com/adamazing) in [mermaid-js/mermaid#4467 - Document recommended file extension and MIME type docs by [@​bollwyvl](https://github.com/bollwyvl) in [mermaid-js/mermaid#4485 - Fix typo in quadrant chart documentation by [@​tobie](https://github.com/tobie) in [mermaid-js/mermaid#4512 - fix cspell issues in \*.md files by [@​Yokozuna59](https://github.com/Yokozuna59) in [mermaid-js/mermaid#4531 - docs: Howto on foreground color on timelines by [@​mcbeelen](https://github.com/mcbeelen) in [mermaid-js/mermaid#4524 - Add citation.cff file by [@​schackartk](https://github.com/schackartk) in [mermaid-js/mermaid#4521 - Update Tutorials.md by [@​ellenealds](https://github.com/ellenealds) in [mermaid-js/mermaid#4539 - Add Standard Notes extension in integrations page by [@​nienow](https://github.com/nienow) in [mermaid-js/mermaid#4557 - Fix up Gantt Chart demo by [@​AlexMooney](https://github.com/AlexMooney) in [mermaid-js/mermaid#4561 #### Chore - Update all patch dependencies (patch) by [@​renovate](https://github.com/renovate) in [mermaid-js/mermaid#4482 - chore: revise Contributing documentation by [@​weedySeaDragon](https://github.com/weedySeaDragon) in [mermaid-js/mermaid#3814 - chore(deps): update all minor dependencies (minor) by [@​renovate](https://github.com/renovate) in [mermaid-js/mermaid#4435 - fix(deps): update all patch dependencies (patch) by [@​renovate](https://github.com/renovate) in [mermaid-js/mermaid#4510 - fix(deps): update all patch dependencies (patch) by [@​renovate](https://github.com/renovate) in [mermaid-js/mermaid#4535 - chore(deps): update dependency eslint-plugin-jsdoc to v46 by [@​renovate](https://github.com/renovate) in [mermaid-js/mermaid#4544 - chore(deps): update dependency jsdom to v22 by [@​renovate](https://github.com/renovate) in [mermaid-js/mermaid#4546 - chore(deps): update dependency eslint-plugin-unicorn to v47 by [@​renovate](https://github.com/renovate) in [mermaid-js/mermaid#4545 - chore(deps): update dependency workbox-window to v7 by [@​renovate](https://github.com/renovate) in [mermaid-js/mermaid#4547 - chore(deps): update node.js to v20 by [@​renovate](https://github.com/renovate) in [mermaid-js/mermaid#4548 - fix(deps): update all patch dependencies (patch) by [@​renovate](https://github.com/renovate) in [mermaid-js/mermaid#4543 - add `Suggested Solutions` field in `bug_report.yml` by [@​Yokozuna59](https://github.com/Yokozuna59) in [mermaid-js/mermaid#4541 #### New Contributors - [@​Spiderpig86](https://github.com/Spiderpig86) made their first contribution in [mermaid-js/mermaid#4472 - [@​adamazing](https://github.com/adamazing) made their first contribution in [mermaid-js/mermaid#4475 - [@​koppor](https://github.com/koppor) made their first contribution in [mermaid-js/mermaid#4096 - [@​nirname](https://github.com/nirname) made their first contribution in [mermaid-js/mermaid#4478 - [@​Yokozuna59](https://github.com/Yokozuna59) made their first contribution in [mermaid-js/mermaid#4486 - [@​jonathan-r-young](https://github.com/jonathan-r-young) made their first contribution in [mermaid-js/mermaid#4460 - [@​tobie](https://github.com/tobie) made their first contribution in [mermaid-js/mermaid#4512 - [@​schackartk](https://github.com/schackartk) made their first contribution in [mermaid-js/mermaid#4521 - [@​mcbeelen](https://github.com/mcbeelen) made their first contribution in [mermaid-js/mermaid#4524 - [@​ellenealds](https://github.com/ellenealds) made their first contribution in [mermaid-js/mermaid#4539 - [@​nienow](https://github.com/nienow) made their first contribution in [mermaid-js/mermaid#4557 - [@​AlexMooney](https://github.com/AlexMooney) made their first contribution in [mermaid-js/mermaid#4561 **Full Changelog**: mermaid-js/mermaid@v10.2.3...v10.2.4 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/levaintech/contented). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xNDQuMiIsInVwZGF0ZWRJblZlciI6IjM1LjE0NC4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📑 Summary
Support for development via Docker.
node_modules/.runsh script for seamless integration📏 Design Decisions
runsh script is an alias for common commands to be executed within docker, prefer overdipand other tools to avoid additional dependencies for development.shextension prior to shebangrunsh directly because pre-commits run locally, not within a container, one may need linters to take care of the code before pushing📋 Tasks
Make sure you
developbranch