Skip to content

docs(release-notes): block direct edits and add contribution example#5601

Merged
kugesan1105 merged 16 commits intojaseci-labs:mainfrom
SandeepaHWP:update/release-notes
Apr 20, 2026
Merged

docs(release-notes): block direct edits and add contribution example#5601
kugesan1105 merged 16 commits intojaseci-labs:mainfrom
SandeepaHWP:update/release-notes

Conversation

@SandeepaHWP
Copy link
Copy Markdown
Collaborator

@SandeepaHWP SandeepaHWP commented Apr 17, 2026

Summary

Two improvements to the release notes workflow:

1. Block direct edits to release notes files (scripts/check-release-notes.sh):

  • Added a check that fails PRs which directly modify the main release notes files (e.g. docs/docs/community/release_notes/jaclang.md)
  • These files are managed automatically in the release time - contributors should add fragment files instead

2. Add example PR link (CONTRIBUTING.md, unreleased/README.md):

  • Added a link to #5573 as a real example of a PR with a release note fragment
  • Added to both CONTRIBUTING.md and docs/docs/community/release_notes/unreleased/README.md

@SandeepaHWP SandeepaHWP changed the title Add Example PR docs(release-notes): block direct edits and add contribution example Apr 18, 2026
@kugesan1105
Copy link
Copy Markdown
Member

@SandeepaHWP
this is good, but then how the release prs will be merged into main , this will fail?
bcz during release pr , github actions bot will edit the release notes .md files
image

Comment thread scripts/check-release-notes.sh Outdated
@kugesan1105 kugesan1105 merged commit 81a0528 into jaseci-labs:main Apr 20, 2026
13 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.

2 participants