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

feat(ci): new changelog workflow #858

Merged
merged 1 commit into from
May 14, 2024
Merged

feat(ci): new changelog workflow #858

merged 1 commit into from
May 14, 2024

Conversation

hoangdv2429
Copy link
Contributor

PR Standards

Opening a pull request should be able to meet the following requirements


This PR add auto changelog workflow as the following:

When new commit pushed/PR merged to main branch then

Check if a changelog PR already opened:

  • (Yes) merge from main branch (with ort strag) if needed, then new changelog entry will be append to changelog.md and update to already open PR then exit.
  • (No) checkout from main branch, generate changelog entry and create PR.

Branch should delete automatically on next ci run, or you can delete it manully.

NOTE

Do not create branch "auto-changelog-update-do-not-create-manually" manually.

For Author:

  • Targeted PR against correct branch
  • included the correct type prefix in the PR title
  • Linked to Github issue with discussion and accepted design
  • Targets only one github issue
  • Wrote unit and integration tests
  • All CI checks have passed
  • Added relevant godoc comments

For Reviewer:

  • confirmed the correct type prefix in the PR title
  • Reviewers assigned
  • confirmed all author checklist items have been addressed

After reviewer approval:

  • In case targets main branch, PR should be squashed and merged.
  • In case PR targets a release branch, PR should be rebased.

@hoangdv2429 hoangdv2429 requested a review from a team as a code owner May 14, 2024 10:45
@omritoptix omritoptix merged commit 5a562ad into main May 14, 2024
3 checks passed
@omritoptix omritoptix deleted the feat/auto_changelog branch May 14, 2024 11:56
omritoptix pushed a commit that referenced this pull request May 18, 2024
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