DEPLOYMENT.md

Releasing the gem

Credentials set up

Make sure you have access in https://rubygems.org/gems/auth0/ and that your Ruby Gems tokens are set in ~/.gem/credentials.

Release process

# Install gems
bundle install

# Run all tests
bundle exec rake test

# Create a release branch
git checkout main
git pull
git checkout -b release-X.X.X
git push --set-upstream origin release-X.X.X

# Update the version number in lib/auth0/version.rb
# Commit the version bump
git commit -am "Bump version to X.X.X"

# Make sure the Gemfile.lock is up-to-date
bundle update
git commit -am "Update gems"

# Commit, push, and create a PR for this release
git push

# Create PR on GitHub and assign for review
# Merge and delete branch once approved

# Create and add a tag
git checkout main
git pull
git tag vX.X.X
git push origin vX.X.X

# Create a new release from this tag on GitHub

# Publish to RubyGems
# Make sure you are an author for this gem: https://rubygems.org/gems/auth0/
gem build auth0.gemspec
gem push auth0-X.X.X.gem

Notes

• The Management API client is generated by Fern. Run fern generate to update it. After regeneration, check for new management resource accessors and update lib/auth0/auth_client.rb accordingly.
• Files listed in .fernignore are not overwritten by Fern regeneration.