Skip to content

[docs] Clarify changelog workflow permissions (#118)#120

Merged
coisa merged 3 commits intomainfrom
codex/118-changelog-workflow-permissions
Apr 19, 2026
Merged

[docs] Clarify changelog workflow permissions (#118)#120
coisa merged 3 commits intomainfrom
codex/118-changelog-workflow-permissions

Conversation

@coisa
Copy link
Copy Markdown
Contributor

@coisa coisa commented Apr 19, 2026

Summary

Documents the GitHub Actions repository settings required for the changelog release workflow introduced by #28.

Included

  • explain that the changelog release flow is two-step:
    • workflow_dispatch prepares a release/v... pull request
    • merging that release pull request publishes the GitHub release and tag
  • clarify that ordinary feature or fix pull requests merged into main do not publish releases
  • document the required repository settings under Settings -> Actions -> General
  • call out the blocked or grayed-out settings case and explain that it usually comes from repository permissions or organization policy, not branch protection
  • update README and Sphinx docs where the release workflow is described

Validation

  • git diff --check
  • reviewed the updated docs in:
    • README.md
    • docs/usage/github-actions.rst
    • docs/internals/release-publishing.rst
    • docs/configuration/repository-setup.rst

Notes

This is a documentation follow-up to the changelog automation shipped in #28. It does not change the release strategy itself.

Closes #118
Related to #28

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 19, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 19, 2026

@coisa coisa merged commit 7446054 into main Apr 19, 2026
21 checks passed
@coisa coisa deleted the codex/118-changelog-workflow-permissions branch April 19, 2026 21:09
github-actions Bot added a commit that referenced this pull request Apr 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Released

Development

Successfully merging this pull request may close these issues.

[docs] Document required GitHub Actions permissions for changelog release automation

1 participant