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

chore: Refactor release steps ensuring tag is created before running tests and creating release #2154

Merged
merged 10 commits into from
Apr 18, 2024

Conversation

AgustinBettati
Copy link
Member

@AgustinBettati AgustinBettati commented Apr 16, 2024

Description

Link to any related issue(s): CLOUDP-242972

Release process steps now prioritises creating a release tag as soon as all quick validations and automatic commits are made. New order of steps:

  • validate version input
  • automatic commit updating changelog header
  • automatic commit udpating terraform docs referencing examples section
  • create release tag
  • run acceptance tests using the created tag
  • generate release (go-releaser) using the created tag

Within 30 seconds the new tag is created, following steps for running acceptance tests and creating the release use the created tag. This ensures any new merges to master do not impact an ongoing release process.

Testing

  • Ran a release process in a forked repository which simulated acceptance tests with a 5min sleep step, and within that timeframe made a commit and ensured that it was not included in the final release that was generated.
  • Triggered release making use of existing tag: verified no automatic commits or tags were made, tests + release process + jira update is executed.
  • Triggered release making use of skip acceptance tests: verified commits + new tag + release process + jira update is executed.
  • Triggered release making use of skip acceptance tests and existing tag: verified no automatic commits or tags were made, release process + jira update is executed.
  • Triggered a pre-release: verified no commits were created, new tag + release process is run, jira step is skipped.

Type of change:

  • Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
  • New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the contributing guides
  • I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • I have added any necessary documentation (if appropriate)
  • I have run make fmt and formatted my code
  • If changes include deprecations or removals, I defined an isolated PR with a relevant title as it will be used in the auto-generated changelog.
  • If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

@AgustinBettati AgustinBettati marked this pull request as ready for review April 17, 2024 09:28
@AgustinBettati AgustinBettati requested a review from a team as a code owner April 17, 2024 09:28
Copy link
Member

@lantoli lantoli left a comment

Choose a reason for hiding this comment

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

LGTM

RELEASING.md Outdated Show resolved Hide resolved
@AgustinBettati AgustinBettati merged commit 1400b8a into master Apr 18, 2024
31 checks passed
@AgustinBettati AgustinBettati deleted the CLOUDP-242972 branch April 18, 2024 07:29
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