Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR removes the redundant generate-changelog.yaml GitHub Actions workflow (previously generating a second changelog via commit messages) and updates docs/workflows to rely on the existing release-please changelog setup.
Changes:
- Deleted the
.github/workflows/generate-changelog.yamlworkflow and removed its invocation fromon-push-main-branch.yaml. - Simplified
publish-docs.yamlto build docs directly (no changelog artifact download/injection). - Updated documentation pages to remove references to the removed workflow.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| documentation/docs/contribute/development-guide/05-publishing.md | Removes generate-changelog from workflow documentation tables. |
| documentation/docs/contribute/03-documentation.md | Updates docs publishing description to reflect the simplified docs build/publish flow. |
| .github/workflows/publish-docs.yaml | Removes changelog artifact handling and message inputs; builds docs directly. |
| .github/workflows/on-push-main-branch.yaml | Removes the generate-changelog job and updates docs job dependencies accordingly. |
| .github/workflows/generate-changelog.yaml | Deletes the redundant changelog generation workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
d2c519c to
8694524
Compare
8694524 to
efb7e32
Compare
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.
Why is this pull request needed?
The
generate-changelog.yamlworkflow "Automatically generates changelogs based on commit messages". This is also exactly whatrelease-pleasedoes, and by the looks of it thegenerate-changelogworkflow is no longer needed (or used).What does this pull request change?
generate-changelog.yamlworkflow and references to it from docs and other workflows.documentation/docs/changelog/changelog.md)Note
Changes for docusaurus might be "redundant" if the
/documentationfolder is to be removed anyway by #435, but thegenerate-changelog.yamlworkflow can/should be removed either wayFor context, currently two seperate changelogs are generated from the same commit messages and both are added to the github pages docs site. However, only the current
release-pleasechangelog appears as an available page/tab:https://equinor.github.io/template-fastapi-react/docs/changelog
The other changelog can still be found by manually going to
https://equinor.github.io/template-fastapi-react/changelog/
Its also worth mentioning that the current configuration seems to "mess up" the release please changelog by also appending the "custom" changelog to its end, overwriting the docusaurus ToC.