Skip to content

chore: remove generate-changelog workflow#444

Merged
sutne merged 1 commit intomainfrom
chore/remove-generate-changelog-workflow
Mar 24, 2026
Merged

chore: remove generate-changelog workflow#444
sutne merged 1 commit intomainfrom
chore/remove-generate-changelog-workflow

Conversation

@sutne
Copy link
Copy Markdown
Contributor

@sutne sutne commented Mar 23, 2026

Why is this pull request needed?

The generate-changelog.yaml workflow "Automatically generates changelogs based on commit messages". This is also exactly what release-please does, and by the looks of it the generate-changelog workflow is no longer needed (or used).

What does this pull request change?

  • Removes the generate-changelog.yaml workflow and references to it from docs and other workflows.
  • Removes outdated/no longer maintained root CHANGELOG.md (moved its contents to documentation/docs/changelog/changelog.md)

    Alternatively could change release-please config to update the root CHANGELOG.md instead, point being there should only be a single changelog file.


Note

Changes for docusaurus might be "redundant" if the /documentation folder is to be removed anyway by #435, but the generate-changelog.yaml workflow can/should be removed either way

For 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-please changelog 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/

It also uses incorrect dates for the actual released versions/tags

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.

Screenshot 2026-03-23 at 09 59 32

Copy link
Copy Markdown

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

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.yaml workflow and removed its invocation from on-push-main-branch.yaml.
  • Simplified publish-docs.yaml to 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.

@sutne sutne force-pushed the chore/remove-generate-changelog-workflow branch from d2c519c to 8694524 Compare March 23, 2026 09:27
@sutne sutne force-pushed the chore/remove-generate-changelog-workflow branch from 8694524 to efb7e32 Compare March 23, 2026 09:40
@sutne sutne marked this pull request as ready for review March 23, 2026 09:46
@sutne sutne requested a review from a team as a code owner March 23, 2026 09:46
Copy link
Copy Markdown
Contributor

@einarwar einarwar left a comment

Choose a reason for hiding this comment

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

LGTM. Nice cleanup!

@sutne sutne merged commit 1879445 into main Mar 24, 2026
11 checks passed
@sutne sutne deleted the chore/remove-generate-changelog-workflow branch March 24, 2026 08:48
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.

3 participants