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

Update github workflow to update changelog on every PR merge #108

Merged
merged 5 commits into from
Oct 28, 2024

Conversation

amishas157
Copy link
Contributor

@amishas157 amishas157 commented Oct 28, 2024

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with the jira ticket associated with the PR.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated the docs and README with the added features, breaking changes, new instructions on how to use the repository.

Release planning

  • I've decided if this PR requires a new major/minor/patch version accordingly to
    semver, and I've changed the name of the BRANCH to release/* , feature/* or patch/* .

What

This PR:

  • updates Release Drafter and Publisher workflow to update changelog.md on branch merge to master
  • updates branch prefixing to start with major/minor/patch and not release/feature/patch
  • default to patch in case branch does not start with these prefixes. That means every PR will have changelog

Similar efforts to stellar/stellar-etl#286

Why

To keep track of code changes over time

Known limitations

[TODO or N/A]

github-actions bot pushed a commit that referenced this pull request Oct 28, 2024
@amishas157 amishas157 changed the title Add changelog file and update github workflow to update it when PR me… Update github workflow to update changelog on every PR merge Oct 28, 2024
@amishas157 amishas157 marked this pull request as ready for review October 28, 2024 16:34
@amishas157 amishas157 requested a review from a team as a code owner October 28, 2024 16:34
@amishas157 amishas157 merged commit 4183a81 into master Oct 28, 2024
3 checks passed
@sydneynotthecity sydneynotthecity deleted the patch/add-changelog branch November 14, 2024 16:41
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.

2 participants