Skip to content

Conversation

@timo282
Copy link
Collaborator

@timo282 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

@timo282 timo282 requested review from Copilot, finitearth and mo374z May 17, 2025 22:42
@timo282
Copy link
Collaborator Author

timo282 commented May 17, 2025

Note: dev branch can be deleted after this PR

Copy link
Contributor

Copilot AI left a 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

mo374z and others added 2 commits May 18, 2025 09:30
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Collaborator

@mo374z mo374z left a comment

Choose a reason for hiding this comment

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

Basst so :)

@mo374z mo374z merged commit cac2db2 into main May 18, 2025
2 checks passed
@mo374z mo374z deleted the chore/update-cicd-process branch May 18, 2025 16:32
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.

4 participants