Skip to content

fix #241 - bug: Generated CHANGELOG files are missing Apache license header#244

Merged
ricardozanini merged 1 commit into
open-workflow-specification:mainfrom
fantonangeli:issue-241-bug-Generated-CHANGELOG-files-are-missing-Apache-license-header
Jul 8, 2026
Merged

fix #241 - bug: Generated CHANGELOG files are missing Apache license header#244
ricardozanini merged 1 commit into
open-workflow-specification:mainfrom
fantonangeli:issue-241-bug-Generated-CHANGELOG-files-are-missing-Apache-license-header

Conversation

@fantonangeli

Copy link
Copy Markdown
Member

Closes #241

Describe the Bug

The release preparation workflow generates package CHANGELOG.md files without the Apache license header.
This makes the Apache RAT check fail on release PRs.
See logs here:


Run APACHE_RAT_JAR="${RUNNER_TEMP:-/tmp}/apache-rat-${APACHE_RAT_VERSION}.jar"
❌ Apache RAT check FAILED - Files with unapproved licenses found:

! /packages/i18n/CHANGELOG.md
! /packages/serverless-workflow-diagram-editor/CHANGELOG.md
Error: Process completed with exit code 1.

Steps to reproduce

  1. Run the release preparation workflow: https://github.com/serverlessworkflow/editor/actions/workflows/prepare-release.yaml
  2. Open the generated release PR.
  3. Check the CI :: License headers job.

Expected Behavior

Generated CHANGELOG.md files should include the Apache license header and pass the Apache RAT check.

Solution

I could not find a changeset option to prepend the license text in the CHANGELOG.
I tried locally adding the license before and after the package name, but that text was partially replaced or moved down with the version.
Adding the license to the bottom generated a correct changelog locally and the license was kept at the bottom as expected.
This should be ok for RAT, otherwise we can add the changelogs in .rat-excludes

Signed-off-by: fantonangeli <fabrizio.antonangeli@gmail.com>
Copilot AI review requested due to automatic review settings July 8, 2026 09:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 addresses issue #241 by ensuring package-level CHANGELOG.md files contain an Apache 2.0 license header so the Apache RAT license-header check passes during release PR CI.

Changes:

  • Added an Apache 2.0 license header block (as an HTML comment) to the end of packages/i18n/CHANGELOG.md.
  • Added an Apache 2.0 license header block (as an HTML comment) to the end of packages/serverless-workflow-diagram-editor/CHANGELOG.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
packages/i18n/CHANGELOG.md Appends Apache 2.0 license header to satisfy RAT license scanning for the generated changelog.
packages/serverless-workflow-diagram-editor/CHANGELOG.md Appends Apache 2.0 license header to satisfy RAT license scanning for the generated changelog.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@fantonangeli fantonangeli added bug Something isn't working github_actions Pull requests that update GitHub Actions code labels Jul 8, 2026

@lornakelly lornakelly left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@ricardozanini ricardozanini merged commit 1a377f3 into open-workflow-specification:main Jul 8, 2026
7 checks passed
@fantonangeli fantonangeli deleted the issue-241-bug-Generated-CHANGELOG-files-are-missing-Apache-license-header branch July 9, 2026 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug: Generated CHANGELOG files are missing Apache license header

4 participants