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 #286

Merged
merged 6 commits into from
Oct 28, 2024

Conversation

amishas157
Copy link
Contributor

@amishas157 amishas157 commented Oct 25, 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 README with the added features, breaking changes, new instructions on how to use the repository. I updated the description of the fuction with the changes that were made.

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

Why

To keep track of code changes over time

Sample output
Screenshot 2024-10-25 at 5 16 22 PM

Known limitations

[TODO or N/A]

@amishas157 amishas157 force-pushed the patch/add-changelog branch 2 times, most recently from fcd16e1 to ad7e3c8 Compare October 25, 2024 20:50
github-actions bot pushed a commit that referenced this pull request Oct 25, 2024
github-actions bot pushed a commit that referenced this pull request Oct 25, 2024
github-actions bot pushed a commit that referenced this pull request Oct 25, 2024
github-actions bot pushed a commit that referenced this pull request Oct 25, 2024
github-actions bot pushed a commit that referenced this pull request Oct 25, 2024
Update changelog and commit

Test on push

test with github action as username

update

test

test

Update CHANGELOG.md for PR #286

update format

add new changelog to the top

append and not overwrite

Add more info to changelog
github-actions bot pushed a commit that referenced this pull request Oct 25, 2024
…h in case branch name not prefixed accordingly
github-actions bot pushed a commit that referenced this pull request Oct 25, 2024
@amishas157 amishas157 marked this pull request as ready for review October 25, 2024 22:17
@amishas157 amishas157 requested a review from a team as a code owner October 25, 2024 22:17
@amishas157 amishas157 changed the title update github workflow to write changelog Update github workflow to update changelog on every PR merge Oct 25, 2024
lint
@@ -51,12 +52,31 @@ jobs:
elif [[ $BRANCH_NAME =~ ^feature/ ]]; then
Copy link
Contributor

Choose a reason for hiding this comment

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

Need to update release and feature in to major and minor in the if/else

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed

CHANGELOG.md Outdated Show resolved Hide resolved
@amishas157 amishas157 merged commit 6a249cb into master Oct 28, 2024
8 checks passed
@amishas157 amishas157 mentioned this pull request Oct 28, 2024
6 tasks
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