Skip to content

fix(references): unblock CI on imported RELEASE.md and prevent recurrence - #678

Merged
viniciusdc merged 5 commits into
mainfrom
fix/release-md-import-checks
Jun 3, 2026
Merged

fix(references): unblock CI on imported RELEASE.md and prevent recurrence#678
viniciusdc merged 5 commits into
mainfrom
fix/release-md-import-checks

Conversation

@khuyentran1401

Copy link
Copy Markdown
Collaborator

Reference Issues or PRs

Fixes #677.

What does this implement/fix?

  • Patches the current RELEASE.md so MDX can compile it and Prettier accepts its formatting, unblocking PR CI across the repo.
  • Adds a guard workflow (.github/workflows/auto-format-release.yml) that triggers on any PR touching RELEASE.md, escapes unescaped <token> patterns, runs Prettier, and commits the fixes back. This prevents future syncs from the upstream bot from breaking CI in the same way.

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Ran the two CI checks locally from docs/: yarn run format prints "All matched files use Prettier code style", and npx docusaurus build ends with [SUCCESS] Generated static files in "build".

@netlify

netlify Bot commented Jun 1, 2026

Copy link
Copy Markdown

Deploy Preview for nebari-docs2 ready!

Name Link
🔨 Latest commit 520e524
🔍 Latest deploy log https://app.netlify.com/projects/nebari-docs2/deploys/6a1ee8aa1b5501000877fd78
😎 Deploy Preview https://deploy-preview-678--nebari-docs2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@khuyentran1401
khuyentran1401 requested a review from viniciusdc June 1, 2026 09:15
Comment thread .github/workflows/auto-format-release.yml

@viniciusdc viniciusdc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the message @khuyentran1401 looking great, can you have a look at the final changes bellow?

Comment thread docs/docs/references/RELEASE.md
Comment thread docs/docs/references/RELEASE.md Outdated
@khuyentran1401
khuyentran1401 requested a review from viniciusdc June 2, 2026 14:30
@viniciusdc
viniciusdc merged commit 7979fc2 into main Jun 3, 2026
7 checks passed
@viniciusdc
viniciusdc deleted the fix/release-md-import-checks branch June 3, 2026 02:34
@github-project-automation github-project-automation Bot moved this from Todo 📬 to Done 💪🏾 in 📖 - Documentation Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Status: Done 💪🏾

Development

Successfully merging this pull request may close these issues.

[Bug] Imported RELEASE.md fails Prettier and MDX checks, blocking PRs

2 participants