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

chores(ci): update changelog workflow #245

Merged
merged 7 commits into from
May 27, 2024

Conversation

hoangdv2429
Copy link
Contributor

Description

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 manually.

NOTE

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

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow-up issues.

PR review checkboxes:

I have...

  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Targeted PR against the correct branch
  • included the correct type prefix in the PR title
  • Linked to the GitHub issue with discussion and accepted design
  • Targets only one GitHub issue
  • Wrote unit and integration tests
  • Wrote relevant migration scripts if necessary
  • All CI checks have passed
  • Added relevant godoc comments
  • Updated the scripts for local run, e.g genesis_config_commands.sh if the PR changes parameters
  • Add an issue in the e2e-tests repo if necessary

SDK Checklist

  • Import/Export Genesis
  • Registered Invariants
  • Registered Events
  • Updated openapi.yaml
  • No usage of go map
  • No usage of time.Now()
  • Used fixed point arithmetic and not float arithmetic
  • Avoid panicking in Begin/End block as much as possible
  • No unexpected math Overflow
  • Used sendCoin and not SendCoins
  • Out-of-block compute is bounded
  • No serialized ID at the end of store keys
  • UInt to byte conversion should use BigEndian

Full security checklist here

----;

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 the PR targets the main branch, PR should not be squash merge in order to keep meaningful git history.
  • In case the PR targets a release branch, PR must be rebased.

@omritoptix omritoptix changed the title Feat: Update changelog workflow (new flow in description) feat: Update changelog workflow (new flow in description) May 20, 2024
@hoangdv2429
Copy link
Contributor Author

@omritoptix can we review and merge this

@omritoptix omritoptix changed the title feat: Update changelog workflow (new flow in description) chores(ci): update changelog workflow May 27, 2024
@omritoptix omritoptix merged commit 0cf6ec6 into main May 27, 2024
47 of 49 checks passed
@omritoptix omritoptix deleted the feat/update_changelog_workflow branch May 27, 2024 08:52
omritoptix pushed a commit that referenced this pull request Jun 4, 2024
omritoptix pushed a commit that referenced this pull request Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants