Skip to content

Latest commit

 

History

History
92 lines (67 loc) · 2.55 KB

RELEASE.md

File metadata and controls

92 lines (67 loc) · 2.55 KB
Raw

How to make a release

configurable-http-proxy is available as a npm package available on npmjs and a Docker image available on DockerHub. The Docker image is automatically built and published on changes to the git repository as is configured here.

To make a tagged release follow the instructions below, but first make sure you meet the prerequisites:

Steps to make a release

  1. Update CHANGELOG.md if it is not up to date, and verify README.md has an updated output of running --help. Make a PR to review the CHANGELOG notes.

  2. Once the changelog is up to date, checkout the main branch and make sure it is up to date and clean.

    ORIGIN=${ORIGIN:-origin} # set to the canonical remote, e.g. 'upstream' if 'origin' is not the official repo
git checkout main
git branch --set-upstream-to=$ORIGIN/main main
git pull

  3. Update the version with npm version and let it make a git commit and tag as well for us.

    # specify the new version here,
# which should already have been chosen when updating the changelog.
npm version 1.2.3

# verify changes
git diff HEAD~1

  4. Reset the version to the next development version with npm version, without creating a tag:

    npm version --no-git-tag-version prerelease --preid=dev
git commit -am "back to dev"

# verify changes
git diff HEAD~1

  5. Push your new tag and commits to GitHub.

    git push --follow-tags $ORIGIN main

  6. Verify the automated workflow succeeded.

Manual release to npm

A manual release should not generally be required, but might be needed in the event of a problem in the automated publishing workflow.

  1. Verify you are a collaborator of the npmjs project.

  2. Checkout the git tag.

    git checkout <tag>

  3. Cleanup old node_modules etc.

    git clean -xfd

  4. Publish to NPM.

    npm login
npm publish