Repository navigation
Add a changelog populated from GitHub releases - #14
Merged
james-d-mitchell merged 2 commits intoOct 27, 2026
Merged
james-d-mitchell merged 2 commits into
james-d-mitchell merged 2 commits into
Conversation
Generate release notes during site builds and link the changelog from Home. Provide GitHub tokens in the build workflows and test pagination, Markdown rendering, empty releases, and API failures. AI assistance: OpenAI Codex implemented the changelog, documentation, tests, and commit message. Co-authored-by: Codex <noreply@openai.com>
Copy the branch, fork, pull request, and AI disclosure guidance from libsemigroups/AGENTS.md, adapting repository URLs for the tutorial. AI assistance: OpenAI Codex copied and adapted the guidance and prepared this commit message. Co-authored-by: Codex <noreply@openai.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a changelog linked from Home that imports published GitHub release descriptions at build time, with publication dates and release links. The page stays out of the navigation menu, and publishing a release refreshes it through the existing deployment workflow.
Provide the build workflows with GitHub tokens, document how to refresh edited release notes, and add tests for pagination, draft filtering, Markdown rendering, empty descriptions, and API failures. Also copy the Git branch, fork, PR, and AI disclosure guidance into AGENTS.md with the tutorial repository URLs.
Validation: all seven changelog tests pass; the site builds with
mkdocs build --clean --strict; generated HTML confirms the Home link, populated release notes, and absence from navigation menus.AI assistance: OpenAI Codex implemented the changes, ran validation, and prepared the commits and this PR. Both commits include Codex co-author attribution.