Skip to content

Commit

Permalink
Merge pull request avh4#557 from avh4/release-prep
Browse files Browse the repository at this point in the history
Prepare 0.8.1
  • Loading branch information
avh4 authored Oct 2, 2018
2 parents 94f43d7 + 29cc249 commit 7649336
Show file tree
Hide file tree
Showing 7 changed files with 48 additions and 19 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## master (0.8.1)
## 0.8.1

New features:
- `elm-format` now automatically detects your Elm version based on your `elm.json` or `elm-package.json`.
Expand Down
13 changes: 5 additions & 8 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ brew cask install virtualbox

## Preparation

1. Edit `CHANGELOG.md` to set the correct version number.
1. Create `Release Notes/<version>.md` to draft the release notes.
1. Update the version number in `elm-format.cabal`.
1. Edit `CHANGELOG.md` to set the correct version number.
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>")`
Expand Down Expand Up @@ -49,8 +49,8 @@ brew cask install virtualbox

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. Upload the zip, tgz and asc files.
1. Write the release notes.
1. Publish the release.
1. Update `README.md`

Expand All @@ -63,10 +63,7 @@ npm install
# for experimental releases
# npm publish --tag exp
npm publish
npm dist-tag add elm-format@<new version> elm0.18.0
npm dist-tag add elm-format@<new version> elm0.19.0
npm dist-tag add elm-format@<new version> exp
```


## Clean up

1. Edit `elm-format.cabal` with the next minor version number and add `-dev`.
1. Commit the change to `elm-format.cabal`.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![Build Status](https://travis-ci.org/avh4/elm-format.svg?branch=master)](https://travis-ci.org/avh4/elm-format)
[![latest version: 0.8.0](https://img.shields.io/badge/version-0.8.0-orange.svg)](https://github.com/avh4/elm-format/releases/tag/0.8.0)
[![latest version: 0.8.1](https://img.shields.io/badge/version-0.8.1-orange.svg)](https://github.com/avh4/elm-format/releases/tag/0.8.1)

# elm-format

Expand Down Expand Up @@ -29,24 +29,24 @@ elm-format --help # See other command line options
```


## Installation [![(latest version: 0.8.0)](https://img.shields.io/badge/version-0.8.0-orange.svg)](https://github.com/avh4/elm-format/releases/tag/0.8.0)
## Installation [![(latest version: 0.8.1)](https://img.shields.io/badge/version-0.8.1-orange.svg)](https://github.com/avh4/elm-format/releases/tag/0.8.1)

> `elm-format` is still in beta. If you run into any problems, please [report them](https://github.com/avh4/elm-format/issues).
>
> **The format produced by elm-format may change significantly before the 1.0.0 release.** If this will cause problems for you, please refrain from using elm-format during the beta-test period.
To install `elm-format` for Elm 0.19:
To install `elm-format`:

```sh
npm install -g elm-format
```

or download the version appropriate for your OS from the [release page](https://github.com/avh4/elm-format/releases/tag/0.8.0),
or download the version appropriate for your OS from the [release page](https://github.com/avh4/elm-format/releases/tag/0.8.1),
unzip it,
and place `elm-format` or `elm-format.exe` (windows) on your `PATH`.

To use `elm-format` with Elm 0.18, either pass the `--elm-version=0.18` when running `elm-format`,
or use the `*-0.18-*` binaries available from the [release page](https://github.com/avh4/elm-format/releases/tag/0.8.0).
You must run `elm-format` from the directory that contains your `elm.json` (for Elm 0.19) or `elm-package.json` (for Elm 0.18),
or else you must pass the appropriate `--elm-version=0.19`/`--elm-version=0.18` command line argument.


## Editor integration
Expand Down
32 changes: 32 additions & 0 deletions Release Notes/0.8.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## Autodetecting your Elm version

Starting in `elm-format` 0.8.1, there is now only one official binary for each platform
(previously there was a seperate binary for Elm 0.18 and Elm 0.19).
`elm-format` now will auto-detect your Elm version using the following rules:

- if `elm-package.json` exists in the current directory, format in Elm 0.18 mode
- if `elm.json` exists in the current directory, format in Elm 0.19 mode

If you need to run `elm-format` from a working directory that does not contain such a file
(or if you need to use `elm-format` in Elm 0.17 mode),
use the `--elm-version=...` command line argument to disable the autodetection.


## Other changes

`elm-format` 0.8.1 also contains several bug fixes for `elm-format` 0.8.0.
See the [CHANGELOG](https://github.com/avh4/elm-format/blob/0.8.1/CHANGELOG.md) for details.


## Install

```sh
npm install -g elm-format
```

or [download from the release page](https://github.com/avh4/elm-format/releases/tag/0.8.1).


## Thanks to ...

- @andys8 for contributing the lenient import line parser
4 changes: 2 additions & 2 deletions Style Guide/CI.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ A FormattingError will be an object with the following fields:
### Example JSON

```json
[{"path":"./src/Fifo.elm","message":"File is not formatted with elm-format-0.8.0 --elm-version=0.19"}
,{"path":"./tests/Tests.elm","message":"File is not formatted with elm-format-0.8.0 --elm-version=0.19"}
[{"path":"./src/Fifo.elm","message":"File is not formatted with elm-format-0.8.1 --elm-version=0.19"}
,{"path":"./tests/Tests.elm","message":"File is not formatted with elm-format-0.8.1 --elm-version=0.19"}
]
```
2 changes: 1 addition & 1 deletion elm-format.cabal
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name: elm-format
version: 0.8.1-rc2
version: 0.8.1

Synopsis:
A source code formatter for Elm
Expand Down
2 changes: 1 addition & 1 deletion package/npm/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "elm-format",
"version": "0.8.1-rc2",
"version": "0.8.1",
"description": "Install elm-format",
"preferGlobal": true,
"main": "index.js",
Expand Down

0 comments on commit 7649336

Please sign in to comment.