Skip to content

feat: auto-generated release notes on every release - #6

Merged
thangnm93 merged 3 commits into
mainfrom
feature/release-notes
Nov 13, 2026
Merged

thangnm93 merged 3 commits into
mainfrom
feature/release-notes

Conversation

@thangnm93

@thangnm93 thangnm93 commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Every YourSSH release now updates the docs automatically.

  • A new Release notes tab (release-notes.mdx), generated by scripts/gen_release_notes.py from the app's CHANGELOG.md, one Mintlify <Update> per version from 0.2.0 on. MDX-sensitive text outside code is escaped, so CHANGELOG prose can't break the build.
  • .github/workflows/release-notes.yml runs every 6 hours, on demand, or on a yourssh-release repository dispatch:
    • It reads the latest release tag (validated against vX.Y.Z) and the CHANGELOG at that tag, then regenerates the page.
    • If anything changed, it runs mint validate and mint broken-links and opens a PR.
    • It runs docs.yml on that PR to produce the required Build and check status, merges the PR once the check is green, and runs docs.yml on main to deploy.
  • The ruleset is unchanged. This needs the org setting "Allow GitHub Actions to create and approve pull requests".

https://claude.ai/code/session_01YGAGXFNiYwvqiuiRKg25y2

@mintlify

mintlify Bot commented Nov 13, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
yourssh 🟡 Building – Nov 13, 2026, 9:48 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@thangnm93
thangnm93 merged commit aa17944 into main Nov 13, 2026
3 checks passed
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.

1 participant