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

Add automatic changelog generation in release workflow #784

Merged
merged 9 commits into from
Sep 10, 2024

Conversation

spencerugbo
Copy link
Contributor

@spencerugbo spencerugbo commented Aug 13, 2024

Proposed changes

This PR aims to add automatic changelog generation whenever the release workflow is ran.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING document
  • I have run make install-tools and have attached any dependency changes to this pull request
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • If applicable, I have updated any relevant documentation (README.md)
  • If applicable, I have tested my cross-platform changes on Ubuntu 22, Redhat 8, SUSE 15 and FreeBSD 13

Copy link
Collaborator

@dhurley dhurley left a comment

Choose a reason for hiding this comment

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

Since we are always creating a new commit for the updated changelog for each release, then we will always have to create a PR to merge back into main. At the top of this file there is an input called createPullRequest, which we use to determine if we want to automatically create a PR back to main or not. I think you can remove this input and have it that the workflow always creates a PR.

@dhurley dhurley added the v2.x Issues and Pull Requests related to the major version v2 label Aug 14, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 16, 2024
Copy link
Contributor

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/nginx-agent/784/

@dhurley dhurley merged commit 66f75dc into main Sep 10, 2024
38 checks passed
@dhurley dhurley deleted the automatic-changelog-generation branch September 10, 2024 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v2.x Issues and Pull Requests related to the major version v2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants