Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(ci): migrated changelog action on releases for conventional commits only #446

Merged
merged 3 commits into from
Jan 3, 2025

Conversation

antiyro
Copy link
Member

@antiyro antiyro commented Dec 30, 2024

fix(ci): migrated changelog action on releases for conventional commits only

Pull Request type

Please add the labels corresponding to the type of changes your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build-related changes

What is the current behavior?

The CI is extremely intensive and takes a lot of time, largely due to rebases on changelogs. We remove this check from each PR and instead stick to the conventional commit format feat(scope): description when we want it to be included in the changelogs during releases. This will prevent changelogs with multiple useless entries like in our 0.7.0 release and add clarity for users.

Resolves: #NA

What is the new behavior?

  1. Removed the changelog enforcement workflow (changelog.yml)
  2. Removed the changelog check from the PR workflow
  3. Updated the release workflow to automatically generate changelogs from conventional commits

For commits to be included in changelogs, they should follow the conventional commit format:

feat(scope): description
fix(scope): description
chore(scope): description
docs(scope): description

This change will:

  • Speed up CI by removing redundant changelog checks
  • Keep changelogs focused on meaningful changes
  • Reduce noise in the release notes
  • Make it clearer for users what changed in each release

Does this introduce a breaking change?

NO

Other information

@Trantorian1 Trantorian1 added the infrastructure CI/CD, deployment and infrastructure changes label Dec 30, 2024
Copy link
Collaborator

@Trantorian1 Trantorian1 left a comment

Choose a reason for hiding this comment

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

A very welcome change!


- name: Generate Release Notes
id: generate_notes
uses: conventional-changelog/releaser-action@v1
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice! Just linking this issue for completeness sake, touch I don't think it should affect us: TriPSs/conventional-changelog-action#239

@Trantorian1 Trantorian1 merged commit 95fcd78 into main Jan 3, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure CI/CD, deployment and infrastructure changes
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants