Skip to content

Commit

Permalink
Update publishing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
avh4 committed Feb 25, 2020
1 parent a4b6bb1 commit b97e359
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,16 @@ brew cask install virtualbox

## Preparation

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


Expand All @@ -47,9 +48,9 @@ brew cask install virtualbox

## Publishing

1. Run `package/collect_files.sh`
1. Run `./package/collect_files.sh`
1. Go to the release page for the new tag on github.
1. Enter the contents of `Release Notes/<version>.md` as the release notes.
1. Enter the contents of `Release Notes/<new version>.md` as the release notes.
1. Upload the zip, tgz and asc files.
1. Publish the release.
1. Update `README.md`
Expand All @@ -76,4 +77,10 @@ cd package/nix
./build.sh
```

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]"
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>`"


## Cleanup

1. Create and merge a PR for the `release/<new version>` branch
1. Delete the `release/<new version>` branch

0 comments on commit b97e359

Please sign in to comment.