-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Publish Live Editor previews for the develop
& next
branches
#4841
Conversation
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## develop #4841 +/- ##
===========================================
+ Coverage 74.57% 76.41% +1.83%
===========================================
Files 148 148
Lines 13024 13025 +1
Branches 612 612
===========================================
+ Hits 9713 9953 +240
+ Misses 3159 2929 -230
+ Partials 152 143 -9
Flags with carried forward coverage won't be shown. Click here to find out more. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I love the idea behind this, but I think we need to very slightly adjust the name/documentation for it.
Calling this a Beta
makes it sound like it only has -beta.xxx
or -rc.xxx
releases from the Mermaid NPM (e.g. it skips -alpha.xxx
releases): https://www.npmjs.com/package/mermaid?activeTab=versions
If this is the latest commit from the develop
branch, I'd recommend calling it git-develop.mermaid.live
! (many other projects (like Puppeteer) use next
for their unreleased stuff, but we can't use that, since it will be confused with our next
git branch).
Also, please explain what is publishing the beta.mermaid.live
page (even if this is just in the PR description!). Currently, I can't tell if this is built by a GitHub Action in this mermaid
repo, or a GitHub Action in the mermaid-js/mermaid-live-editor
repo, a netlifly config, or if it's just being manually built by you (all of these are okay, but it would be nice to know which it is!).
The site is published using the branch deploy feature of netlify to publish a live editor clone with mermaid compiled from our develop branch. It has no relation with npm publish tags. We could setup |
* develop: docs: Wrap email in <> chore(dev-deps): update @typescript-eslint to v6 chore(deps): update all patch dependencies test(e2e): wait for theme-directives.html test(e2e): remove unused code in theme-directives test(e2e): wait for marker_unique_id.html e2e test
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The site is published using the branch deploy feature of netlify to publish a live editor clone with mermaid compiled from our develop branch.
Awesome! That's really really cool!
I still think we can very slightly improve the docs to make it more clear what it is (e.g. by renaming them to Live Editor - develop preview
, but it's up to you! Maybe it would make things too wordy.
One final thing, this is a super nice change, so do you think it's worth removing the Skip changelog label so it actually does go in the release notes? I'm sure many users would be excited to see this change! If so, we should maybe rename this PR to something like "Publish LiveEditor previews for the develop
& next
branches", just to make this change more obvious to users that read the release notes!
develop
& next
branches
Co-authored-by: Alois Klink <[email protected]>
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.5.1` -> `10.6.0`](https://renovatebot.com/diffs/npm/mermaid/10.5.1/10.6.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.6.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.6.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.5.1/10.6.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.5.1/10.6.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>mermaid-js/mermaid (mermaid)</summary> ### [`v10.6.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.6.0): 10.6.0 [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.5.1...v10.6.0) #### What's Changed - Add new chart xychart by [@​subhash-halder](https://togithub.com/subhash-halder) in [https://github.com/mermaid-js/mermaid/pull/4413](https://togithub.com/mermaid-js/mermaid/pull/4413) #### Fix - bug/4849\_center_axis_labels by [@​dreathed](https://togithub.com/dreathed) in [https://github.com/mermaid-js/mermaid/pull/4860](https://togithub.com/mermaid-js/mermaid/pull/4860) - Better handling of large flowcharts and long edges [@​knsv](https://togithub.com/knsv) #### Docs - Add new Atlassian integrations by [@​janjonas](https://togithub.com/janjonas) in [https://github.com/mermaid-js/mermaid/pull/4862](https://togithub.com/mermaid-js/mermaid/pull/4862) - docs: fix typo by [@​dennis0324](https://togithub.com/dennis0324) in [https://github.com/mermaid-js/mermaid/pull/4887](https://togithub.com/mermaid-js/mermaid/pull/4887) - Update notes on orientation in GitGraph documentation by [@​guypursey](https://togithub.com/guypursey) in [https://github.com/mermaid-js/mermaid/pull/4897](https://togithub.com/mermaid-js/mermaid/pull/4897) - Enhancment: twitter logo in doc by [@​chaursiyasanjeet](https://togithub.com/chaursiyasanjeet) in [https://github.com/mermaid-js/mermaid/pull/4925](https://togithub.com/mermaid-js/mermaid/pull/4925) - Update link for the Mermaid integration in JetBrains IDEs by [@​FirstTimeInForever](https://togithub.com/FirstTimeInForever) in [https://github.com/mermaid-js/mermaid/pull/4883](https://togithub.com/mermaid-js/mermaid/pull/4883) #### Chores - Wait for `marker_unique_id.html` E2E test to render before taking a screenshot by [@​aloi](https://togithub.com/aloi) sklink[https://github.com/mermaid-js/mermaid/pull/4847](https://togithub.com/mermaid-js/mermaid/pull/4847)4847 - Wait for `theme-directives.html` E2E test to render before taking a screenshot by [@​aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/4846](https://togithub.com/mermaid-js/mermaid/pull/4846) - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4851](https://togithub.com/mermaid-js/mermaid/pull/4851) - chore(dev-deps): update `@typescript-eslint/*` plugins to v6 (major) by [@​aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/4857](https://togithub.com/mermaid-js/mermaid/pull/4857) - chore: shorten `flow-huge.spec.js` test case using `.repeat` by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [https://github.com/mermaid-js/mermaid/pull/4859](https://togithub.com/mermaid-js/mermaid/pull/4859) - Publish Live Editor previews for the `develop` & `next` branches by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4841](https://togithub.com/mermaid-js/mermaid/pull/4841) - chore(deps): update all minor dependencies (minor) by [@​renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4870](https://togithub.com/mermaid-js/mermaid/pull/4870) - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4869](https://togithub.com/mermaid-js/mermaid/pull/4869) - Commented out broken test by [@​nirname](https://togithub.com/nirname) in [https://github.com/mermaid-js/mermaid/pull/4913](https://togithub.com/mermaid-js/mermaid/pull/4913) - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4891](https://togithub.com/mermaid-js/mermaid/pull/4891) - fix(class): avoid duplicate definition of fill by [@​Mister-Hope](https://togithub.com/Mister-Hope) in [https://github.com/mermaid-js/mermaid/pull/4929](https://togithub.com/mermaid-js/mermaid/pull/4929) - chore(deps): update all minor dependencies (minor) by [@​renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4892](https://togithub.com/mermaid-js/mermaid/pull/4892) - making consitent config imports from diagramAPI by [@​dreathed](https://togithub.com/dreathed) in [https://github.com/mermaid-js/mermaid/pull/4889](https://togithub.com/mermaid-js/mermaid/pull/4889) - fix(typos): Fix minor typos in the source code by [@​mribeirodantas](https://togithub.com/mribeirodantas) in [https://github.com/mermaid-js/mermaid/pull/4928](https://togithub.com/mermaid-js/mermaid/pull/4928) - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4945](https://togithub.com/mermaid-js/mermaid/pull/4945) - Bump [@​babel/traverse](https://togithub.com/babel/traverse) from 7.22.10 to 7.23.2 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/mermaid-js/mermaid/pull/4951](https://togithub.com/mermaid-js/mermaid/pull/4951) - Replace rehype-mermaidjs with rehype-mermaid by [@​remcohaszing](https://togithub.com/remcohaszing) in [https://github.com/mermaid-js/mermaid/pull/4970](https://togithub.com/mermaid-js/mermaid/pull/4970) #### New Contributors - [@​dreathed](https://togithub.com/dreathed) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4860](https://togithub.com/mermaid-js/mermaid/pull/4860) - [@​janjonas](https://togithub.com/janjonas) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4862](https://togithub.com/mermaid-js/mermaid/pull/4862) - [@​dennis0324](https://togithub.com/dennis0324) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4887](https://togithub.com/mermaid-js/mermaid/pull/4887) - [@​FirstTimeInForever](https://togithub.com/FirstTimeInForever) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4883](https://togithub.com/mermaid-js/mermaid/pull/4883) - [@​guypursey](https://togithub.com/guypursey) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4897](https://togithub.com/mermaid-js/mermaid/pull/4897) - [@​chaursiyasanjeet](https://togithub.com/chaursiyasanjeet) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4925](https://togithub.com/mermaid-js/mermaid/pull/4925) - [@​mribeirodantas](https://togithub.com/mribeirodantas) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4928](https://togithub.com/mermaid-js/mermaid/pull/4928) **Full Changelog**: mermaid-js/mermaid@v10.5.1...v10.6.0 </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:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMS41IiwidXBkYXRlZEluVmVyIjoiMzcuMzEuNSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Adds links to https://develop.git.mermaid.live and https://next.git.mermaid.live
The site is published using the branch deploy feature of netlify to publish a live editor clone with mermaid compiled from the respective branch.