NoRedInk/noredink-ui
1
1
Fork 0
mirror of https://github.com/NoRedInk/noredink-ui.git synced 2024-12-18 11:11:38 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #100 from NoRedInk/ink-james--deploy-steps

Browse Source 
Add deploy steps to README and PR template
This commit is contained in:
James Gary 2018-08-20 14:11:56 -07:00 committed by GitHub
commit e4b47b972c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 34 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -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.

4
docs/pull_request_template.md
View File

@ -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.