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

Improve the release pipeline #31

Merged
merged 8 commits into from
Aug 14, 2020
Merged

Improve the release pipeline #31

merged 8 commits into from
Aug 14, 2020

Conversation

lbalmaceda
Copy link
Contributor

@lbalmaceda lbalmaceda commented Aug 13, 2020

Description

This PR is reusing some old scripts I had around, which I refactored a bit to include the docs and user-agent update, the git tag generation.

Note that this is not going to push the changes nor do npm publish for us. The idea is that the diff gets a chance to be reviewed locally in case the changelog didn't pick the right items.

Usage: Prepare release

  1. Create a milestone v{x.y.z} on Github.
  2. Use the CH: xxxxx labels in your issues or PRs, and add them to the previously created milestone.
  3. Run npm release {x.y.z} and wait for it to finish.
  4. Open a new PR from the prepare/v{x.y.z} branch against master, wait for the CI to pass, and peer approval review.
  5. Merge against master and wait for the CI to pass again.

Errors

If the generated changelog is not correct, or you used the wrong version name, you'll need to delete both the tag and the branch locally before re-running the command.

  1. Run git tag -d v{x.y.z} to delete the local tag.
  2. Run git branch -D prepare/{x.y.z} to delete the local branch.
  3. Run npm run release:clean to remove the temporary files, associated with the failed release.

Usage: Publish to npm

  1. Run npm run release:publish.
  2. Input the OTP code if prompted.

Testing

Manually

  • This change adds test coverage for new/changed/fixed functionality

Checklist

  • I have added documentation for new/changed functionality in this PR or in auth0.com/docs
  • All active GitHub checks for tests, formatting, and security are passing
  • The correct base branch is being used, if not master

@@ -4,7 +4,7 @@
"scripts": {
"ng": "ng",
"start": "ng serve",
"prebuid": "npm run update-useragent",
"prebuild": "npm run update-useragent",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this one drove me nuts 😂

Copy link
Contributor

@stevehobbsdev stevehobbsdev left a comment

Choose a reason for hiding this comment

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

All looks good, just had a question about the changelog. Otherwise, please merge.

CHANGELOG.md Outdated Show resolved Hide resolved
@lbalmaceda lbalmaceda merged commit 9f0a70b into master Aug 14, 2020
@lbalmaceda lbalmaceda deleted the release-pipeline branch August 14, 2020 14:46
@lbalmaceda lbalmaceda added CH: Changed PR is changing something CH: Added PR is adding feature or functionality and removed CH: Changed PR is changing something labels Aug 14, 2020
@lbalmaceda lbalmaceda added this to the v0.2.0 milestone Aug 14, 2020
@stevehobbsdev stevehobbsdev mentioned this pull request Aug 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CH: Added PR is adding feature or functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants