Skip to content
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

docs: add Forgejo as integration #6177

Merged
merged 7 commits into from
Jan 25, 2025

Conversation

Ryuno-Ki
Copy link
Contributor

📑 Summary

Added Forgejo as integration

Resolves N/A (as Add to Mermaid Ecosystem indicated to open a PR directly -- but then Update Documentation is slightly contradicting it here)

📏 Design Decisions

As a (by now hard) fork of Gitea Forgejo has also inherited Mermaid support. (Including security updates when needed)

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests. ➡️ N/A
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features. ➡️ is there something I need to edit also?
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:. ➡️ I went with docs.

Added Forgejo as integration
Copy link

changeset-bot bot commented Jan 10, 2025

⚠️ No Changeset found

Latest commit: de3e381

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Jan 10, 2025

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit de3e381
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/6794bfec711d8600085b4888
😎 Deploy Preview https://deploy-preview-6177--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

pkg-pr-new bot commented Jan 10, 2025

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6177
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6177
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6177
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6177

commit: de3e381

@Ryuno-Ki
Copy link
Contributor Author

Changed files were transformed in src/docs but do not match the files in ../../docs. Please run 'pnpm --filter mermaid run docs:build' after making changes to src/docs to update the ../../docs directory with the transformed files.

Looks like you're not set up to accept changes using GitHub's web editor, huh?

I'll run the command if you have taken a look at the change itself if you want me to.

@sidharthv96
Copy link
Member

Changed files were transformed in src/docs but do not match the files in ../../docs. Please run 'pnpm --filter mermaid run docs:build' after making changes to src/docs to update the ../../docs directory with the transformed files.

Looks like you're not set up to accept changes using GitHub's web editor, huh?

I'll run the command if you have taken a look at the change itself if you want me to.

@Ryuno-Ki We're happy to include the change, we do have automation set up to handle changes from web editor, but it seems like you edited the wrong file.
The path to the right file can be found at the top of the file you edited.

> **Warning**
>
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
>
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/ecosystem/integrations-community.md](../../packages/mermaid/src/docs/ecosystem/integrations-community.md).
# Integrations

Copy link

codecov bot commented Jan 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 4.47%. Comparing base (f4e1f07) to head (de3e381).
Report is 9 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #6177      +/-   ##
==========================================
- Coverage     4.47%   4.47%   -0.01%     
==========================================
  Files          384     385       +1     
  Lines        54179   54190      +11     
  Branches       623     598      -25     
==========================================
  Hits          2425    2425              
- Misses       51754   51765      +11     
Flag Coverage Δ
unit 4.47% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

@Ryuno-Ki
Copy link
Contributor Author

Ah! Now I've edited packages/mermaid/src/docs/ecosystem/integrations-community.md after syncing the repo through the Web UI.

@sidharthv96 sidharthv96 merged commit 4e950e7 into mermaid-js:develop Jan 25, 2025
20 of 21 checks passed
Copy link

mermaid-bot bot commented Jan 25, 2025

@Ryuno-Ki, Thank you for the contribution!
You are now eligible for a year of Premium account on MermaidChart.
Sign up with your GitHub account to activate.

@Ryuno-Ki Ryuno-Ki deleted the forgejo-integration branch January 25, 2025 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants