Skip to content

Commit b97e359

Browse files
committed
Update publishing instructions
1 parent a4b6bb1 commit b97e359

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

PUBLISHING.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,16 @@ brew cask install virtualbox
1717

1818
## Preparation
1919

20+
1. Start a new branch from `origin/master` named `release/<new version>`
2021
1. Edit `CHANGELOG.md` to set the correct version number.
21-
1. Create `Release Notes/<version>.md` to draft the release notes.
22+
1. Create `Release Notes/<new version>.md` to draft the release notes.
2223
1. Update the version number in `elm-format.cabal`.
2324
1. If this is a stable release, update references to the version in `README.md`.
2425
1. Update `ElmFormat.Version.experimental` to `Just <survey URL>` for experimental versions and `Nothing` otherwise.
2526
1. `(cd package/npm && npm version "<new version>")`
26-
1. Commit the changes "Bump version to *new version*"
27-
1. Create a signed tag for the new version. `git tag -s <version> -m <version>`
28-
1. Push the tag. `git push origin <version>`
27+
1. Commit the changes "Bump version to <new version>"
28+
1. Create a signed tag for the new version. `git tag -s <new version> -m <new version>`
29+
1. Push the tag. `git push origin <new version>`
2930
1. Wait for CI to successfully build the tag.
3031

3132

@@ -47,9 +48,9 @@ brew cask install virtualbox
4748

4849
## Publishing
4950

50-
1. Run `package/collect_files.sh`
51+
1. Run `./package/collect_files.sh`
5152
1. Go to the release page for the new tag on github.
52-
1. Enter the contents of `Release Notes/<version>.md` as the release notes.
53+
1. Enter the contents of `Release Notes/<new version>.md` as the release notes.
5354
1. Upload the zip, tgz and asc files.
5455
1. Publish the release.
5556
1. Update `README.md`
@@ -76,4 +77,10 @@ cd package/nix
7677
./build.sh
7778
```
7879

79-
Then `cd nixpkgs`, push the resulting branch, and make a PR to https://github.com/NixOS/nixpkgs with the title "elm-format: [old version] -> [new version]"
80+
Then `cd nixpkgs`, push the resulting branch, and make a PR to <https://github.com/NixOS/nixpkgs> with the title "`elm-format: <old version> -> <new version>`"
81+
82+
83+
## Cleanup
84+
85+
1. Create and merge a PR for the `release/<new version>` branch
86+
1. Delete the `release/<new version>` branch

0 commit comments

Comments
 (0)