-
Notifications
You must be signed in to change notification settings - Fork 5
Chore/update cicd process #48
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
Conversation
timo282
commented
May 17, 2025
- update CICD workflow to automatically write release notes from markdown into GitHub release
- update CICD trigger: deployment must be triggered manually now
- update docs trigger: docs are generated by CICD workflow but can also be triggered manually
- add protection for CICD and docs workflow: workflows can only be triggered from the main branch
|
Note: dev branch can be deleted after this PR |
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.
Pull Request Overview
Updates the CI/CD and documentation pipeline to streamline release note management, enforce branch protections, and enable manual triggers.
- Restructure MkDocs navigation to list release notes per version.
- Add individual Markdown release notes and remove large inlined notes.
- Enforce main-branch guards and manual dispatch in both Docs and CICD workflows, and integrate release-notes into the GitHub Release step.
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Restructured nav to include nested versioned release-notes entries |
| docs/release-notes/v*.md | Added per-version release notes and a template file |
| docs/release-notes.md | Removed inline release notes content; added welcome message |
| .github/workflows/docs.yml | Replaced push trigger with workflow_dispatch and main-branch guard |
| .github/workflows/cicd.yml | Removed push trigger, added branch check, wired body_path for releases, and added create-docs job |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
mo374z
left a comment
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.
Basst so :)