Skip to content

Commit

Permalink
docs/releasing: Use git push --follow-tags
Browse files Browse the repository at this point in the history
Per @jasonkarns in the review for sstephenson#122. _This_ is why we have code
reviews: I'm learning useful little bits like this all the time!

Also took care of a little typo in a command line example, and added a
little info about the Alpine repository.
  • Loading branch information
Bland, Mike committed Jul 9, 2018
1 parent fd465b0 commit cda572b
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions docs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ with the message `Bats <VERSION>`, where `<VERSION>` is the new version number.
Create a new signed, annotated tag with:

```bash
$ git tag -a -s <VERSION>`
$ git tag -a -s <VERSION>
```

Include the `docs/CHANGELOG.md` notes corresponding to the new version as the
Expand All @@ -43,18 +43,13 @@ Added:

## Create a GitHub release

Push the new version commit and tag to GitHub via the following (yes, it must be
two separate commands):
Push the new version commit and tag to GitHub via the following:

```bash
# Push the version commit to `master`:
$ git push
# Push the version tag:
$ git push --tags
$ git push --follow-tags
```

Then visit https://github.com/bats-core/bats-core/releases, then:
Then visit https://github.com/bats-core/bats-core/releases, and:

* Click **Draft a new release**.
* Select the new version tag.
Expand All @@ -63,6 +58,14 @@ Then visit https://github.com/bats-core/bats-core/releases, then:
except change the first line to read: `Released: YYYY-MM-DD`.
* Click **Publish release**.

For more on `git push --follow-tags`, see:

* [git push --follow-tags in the online manual][ft-man]
* [Stack Overflow: How to push a tag to a remote repository using Git?][ft-so]

[ft-man]: https://git-scm.com/docs/git-push#git-push---follow-tags
[ft-so]: https://stackoverflow.com/a/26438076

## NPM

`npm publish`. Pretty easy!
Expand Down Expand Up @@ -105,6 +108,9 @@ SHA512(v1.1.0.zip)=accd83cfec0025a2be40982b3f9a314c2bbf72f5c85daffa9e9419611904a
After cloning alpinelinux/aports, I used the above information to create:
https://github.com/alpinelinux/aports/pull/4696

**Note:** Currently users must enable the `edge` branch of the `community` repo
by adding/uncommenting the corresponding entry in `/etc/apk/repositories`.

## Announce

It's worth making a brief announcement like [the v1.1.0 announcement via
Expand Down

0 comments on commit cda572b

Please sign in to comment.