Deploying (WePay team)

  1. The Makefile (yes, Makefile) has a series of commands to simplify the development and deployment process.
  2. Also install Chag. This is used for managing the CHANGELOG and annotating the Git release correctly.

Updating the CHANGELOG

Make sure that the CHANGELOG.md is human-friendly. See http://keepachangelog.com if you don’t know how.

make

Running make by itself will show you a list of available sub-commands.

$ make
all
docs
install
pushdocs
tag
test
version

make pushdocs

You will need to have write-access to the wepay/signer-php repository on GitHub. You should have already set up:

  • Your SSH key with your GitHub account.
  • Had your GitHub user given write-access to the repository.

Then you can run:

make pushdocs

You can view your changes at https://wepay.github.io/signer-php/.

make version

This allows you to set the version number for the next release.

make tag

This will leverage Chag to generate a commit for the tag.

make tag

Drafting a GitHub release

  1. Go to https://github.com/wepay/signer-php/tags
  2. Find the new tag that you just pushed. Click the ellipsis (…) to see the commit notes. Copy these.
  3. To the right, choose Add release notes. Your Tag version should be pre-filled.
  4. The Release title should match your Tag version.
  5. Inside Describe this release, paste the notes that you copied on the previous page.
  6. Choose Publish release.
  7. Your release should now be the latest. https://github.com/wepay/signer-php/releases/latest