From 02ffb056befb7246747dc1d7a3c74a98cdf63ffa Mon Sep 17 00:00:00 2001 From: James Gary Date: Thu, 16 Aug 2018 13:27:44 -0700 Subject: [PATCH] Add deploy steps to README and PR template --- README.md | 32 ++++++++++++++++++++++++++++++++ docs/pull_request_template.md | 4 ++-- 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b35686aa..e4b13124 100644 --- a/README.md +++ b/README.md @@ -49,3 +49,35 @@ make test Travis will run `make ci` to verify everything looks good. You can run this locally to catch errors before you push! + +## Deploying + +Once you are ready to publish `master` as a new version, run the following to bump the version in `elm-packages.json`: + +``` +elm-package bump +``` + +Commit to a branch and open a pull request. Announce the PR in #eng-front-ops-changes to have it reviewed and merged to `master`. Now you can publish the package! + +``` +elm-package publish # requires a tag, see below +``` + +This will require a tag, so follow the instructions it provides. It should be something like this: + +``` +Verifying NoRedInk/noredink-ui 5.10.0 ... +Version number 5.10.0 verified (MINOR change, 5.9.1 => 5.10.0) +Error: Libraries must be tagged in git, but tag 5.10.0 was not found. + +These tags make it possible to find this specific version on GitHub. +To tag the most recent commit and push it to GitHub, run this: + + git tag -a 5.10.0 -m "release version 5.10.0" + git push origin 5.10.0 +``` + +You can also add a tag in https://github.com/NoRedInk/noredink-ui/releases/new if you want to add more detail. + +Once you've published, you should see the latest version at the top of http://package.elm-lang.org/packages/NoRedInk/noredink-ui/latest. diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index 44fd15c2..097047ee 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -4,5 +4,5 @@ > Then feel free to grab a reviewer from the list below and assign them to the PR! > > https://paper.dropbox.com/doc/noredink-ui-widget-library-fUK6yq32g187lxw2A60a8#:uid=619243092748985044355046&h2=Reviewers-list - -- [ ] Run `elm-package bump` to make sure you're bumping to the correct version +> +> It's best if we have separate pull requests for code changes and package version bumps. If you're just changing code, great! If you're just bumping the version, check out https://github.com/NoRedInk/noredink-ui#deploying.