Skip to content

Commit 93d5e64

Browse files
committed
Update release-it setup
1 parent b4082d5 commit 93d5e64

File tree

3 files changed

+238
-8
lines changed

3 files changed

+238
-8
lines changed

CHANGELOG.md

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
### Changelog
2+
3+
All notable changes to this project will be documented in this file. Dates are displayed in UTC.
4+
5+
Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
6+
7+
### [v4.0.0](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v3.0.0...v4.0.0)
8+
9+
> 15 May 2020
10+
11+
- Update lightning-pack [`#5`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/pull/5)
12+
13+
### [v3.0.0](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v2.2.1...v3.0.0)
14+
15+
> 3 September 2019
16+
17+
- Update to ember-cli 3.12 [`45e3e62`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/45e3e62a7fe41f65d9c39894a2abb1d9115cac88)
18+
- Update lightning-pack [`c34a241`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/c34a24168f6e0a62763bb5d5110626c90f6ba489)
19+
- Released v3.0.0 [`18cc6a5`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/18cc6a5e048ee06028362daabd8c4ecd163c771f)
20+
21+
#### [v2.2.1](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v2.2.0...v2.2.1)
22+
23+
> 4 May 2017
24+
25+
- Update lightning pack [`f3e5941`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/f3e59417d42c3b54f8aec93d76a34f7705ed8ca3)
26+
- Released v2.2.1 [`193ad3e`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/193ad3eca91c12f751d98c3c9a434d7d97ca86d3)
27+
28+
#### [v2.2.0](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v2.1.1...v2.2.0)
29+
30+
> 4 May 2017
31+
32+
- Bump lightning pack [`b47f031`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/b47f031e8c3523e6c178a318adfa1c94d12f6a26)
33+
- Released v2.2.0 [`1477447`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/147744739a442002619a79fc0c878724ece2f44f)
34+
35+
#### [v2.1.1](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v2.1.0...v2.1.1)
36+
37+
> 6 April 2017
38+
39+
- Update lockfile [`247de17`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/247de17e7cdfc3694b1cb6f6c24348fea7a2b3bc)
40+
- Released v2.1.1 [`bb9d829`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/bb9d82929c248fe07f7050b4fcffce03cd3dc10e)
41+
42+
#### [v2.1.0](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v2.0.2...v2.1.0)
43+
44+
> 6 April 2017
45+
46+
- Update dependencies [`4b1af19`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/4b1af191f9958ff8584dd388efd8c30a76a3dda8)
47+
- Released v2.1.0 [`8e94428`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/8e94428f9746aa34de49b05f7777d9208a0bf814)
48+
49+
#### [v2.0.2](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v2.0.1...v2.0.2)
50+
51+
> 25 March 2017
52+
53+
- Eliminate ember-cli deprecation [`5cb16f4`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/5cb16f453e959971870ee810597cd9b40d42034a)
54+
- Released v2.0.2 [`dfccfaa`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/dfccfaa4e92a02b2fdf08ca8079c286877ad6ebc)
55+
56+
#### [v2.0.1](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v2.0.0...v2.0.1)
57+
58+
> 25 March 2017
59+
60+
- Update lockfile [`d96ea97`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/d96ea9753b5622b50607ebf981bc6e3edc9b0370)
61+
- Released v2.0.1 [`256c355`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/256c3553f750534ca398753f3feba83df3cc39f1)
62+
63+
### [v2.0.0](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v1.4.4...v2.0.0)
64+
65+
> 25 March 2017
66+
67+
- Update deps [`da24754`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/da247543b5c85383d0d7c0c4c5428fe7fca49da5)
68+
- Released v2.0.0 [`1d11628`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/1d11628fef1240976a87a18484477ebb3ff9de9b)
69+
70+
#### [v1.4.4](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v1.4.3...v1.4.4)
71+
72+
> 10 March 2017
73+
74+
- Tweak slack message for easier scanning [`#4`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/pull/4)
75+
- Released v1.4.4 [`847e5fb`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/847e5fbae84315e538439f99100e50b2694012a5)
76+
77+
#### [v1.4.3](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v1.4.2...v1.4.3)
78+
79+
> 22 November 2016
80+
81+
- Released v1.4.3 [`8f3dbeb`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/8f3dbeb921dbaabbff063a06efc2bbbb9f4d2225)
82+
- Update lightning-pack [`c980910`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/c980910e1bec0285d18b805fe46f0085b8bf9c32)
83+
84+
#### [v1.4.2](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v1.4.1...v1.4.2)
85+
86+
> 19 November 2016
87+
88+
- Released v1.4.2 [`62ae4a1`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/62ae4a1a1fc07b75d85bc3d44d18666a7f3fd50a)
89+
- Bump lightning pack [`41e5d3b`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/41e5d3b57106bd9063cbdfb28f464132f060d3f1)
90+
91+
#### [v1.4.1](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v1.4.0...v1.4.1)
92+
93+
> 2 November 2016
94+
95+
- Released v1.4.1 [`2f0cbad`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/2f0cbad32b950aaf1c892b21586cd4b40779bd62)
96+
- Bump lightning pack [`8c75e86`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/8c75e8626d37c7e04a33770881e191e7fa9ac319)
97+
98+
#### [v1.4.0](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v1.3.4...v1.4.0)
99+
100+
> 19 October 2016
101+
102+
- Change specifying plugins to new 1.0.0 format API. [`88c6c0d`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/88c6c0dd9e4a9efee64fdc01290c29f264663051)
103+
- Released v1.4.0 [`ec0ca21`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/ec0ca2177cc974a74519123a7d3779cdae916bdc)
104+
105+
#### [v1.3.4](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v1.3.3...v1.3.4)
106+
107+
> 29 June 2016
108+
109+
- Remove zopfli config option [`#3`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/pull/3)
110+
- Released v1.3.3 [`#2`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/pull/2)
111+
- Make devindex deployTarget, which is run on postBuild, use the right distDir. [`#1`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/pull/1)
112+
- Remove zopfli gzip option [`0d0903e`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/0d0903e918f3271b7315a05481163b456808f8d5)
113+
- Released v1.3.4 [`e8d1bbe`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/e8d1bbe903e6e0ce0313e68fe1bf48806414c3cb)
114+
115+
#### [v1.3.3](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v1.3.2...v1.3.3)
116+
117+
> 21 June 2016
118+
119+
- Make devindex deployTarget, which is run on postBuild, use the right distDir. [`8e945d2`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/8e945d24064851d6916bb27262809450a778ae2d)
120+
- Released v1.3.3 [`0dda674`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/0dda674f4658e7106ceaaa10ca72a235cdbd8d2b)
121+
122+
#### [v1.3.2](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v1.3.1...v1.3.2)
123+
124+
> 16 June 2016
125+
126+
- Released v1.3.2 [`1881d0a`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/1881d0abbe2698e2c061e36ba4b279198517643b)
127+
- Update lightning-pack version [`b2727a7`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/b2727a75c553511458d0dd607042e414c2e6db4e)
128+
129+
#### [v1.3.1](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v1.3.0...v1.3.1)
130+
131+
> 1 April 2016
132+
133+
- Released v1.3.1 [`7f3685c`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/7f3685cd870f0f56d2efb9f8d9bbc53ae5a67347)
134+
- Update lightning pack [`6968ebf`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/6968ebfee91ea03950958caff3aa6af0e55fd5c9)
135+
136+
#### [v1.3.0](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v1.2.0...v1.3.0)
137+
138+
> 1 April 2016
139+
140+
- Released v1.3.0 [`30cd718`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/30cd718b51ea6526fc6176ec41d8710c30683ed7)
141+
- Update lightning pack [`8abb1e0`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/8abb1e03dfdbd43996a14b5feb502c8ca23f3797)
142+
143+
#### [v1.2.0](https://github.com/yappbox/ember-cli-deploy-yapp-pack/compare/v1.1.0...v1.2.0)
144+
145+
> 7 February 2016
146+
147+
- Bump dependencies [`5afd5cc`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/5afd5cca7c9459fb6265fa69a01368e0bcc0a840)
148+
- Released v1.2.0 [`069fadc`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/069fadc0b953511951aabe278b24e9ab5c8f77fe)
149+
150+
#### v1.1.0
151+
152+
> 15 December 2015
153+
154+
- Initial commit [`11dfbe2`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/11dfbe2281d5cbcb85c8b0f370b1b59c58c7b0d9)
155+
- Bump lightning pack [`1e17d42`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/1e17d426ff1f5d2464fdbdff9cb2704ed13ce19f)
156+
- Released v1.1.0 [`a5c50e1`](https://github.com/yappbox/ember-cli-deploy-yapp-pack/commit/a5c50e13cb894dfdc9315bce906d1d9697eb653b)

RELEASE.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Release
2+
3+
Releases are mostly automated using
4+
[release-it](https://github.com/release-it/release-it/) and
5+
[lerna-changelog](https://github.com/lerna/lerna-changelog/).
6+
7+
8+
## Preparation
9+
10+
Since the majority of the actual release process is automated, the primary
11+
remaining task prior to releasing is confirming that all pull requests that
12+
have been merged since the last release have been labeled with the appropriate
13+
`lerna-changelog` labels and the titles have been updated to ensure they
14+
represent something that would make sense to our users. Some great information
15+
on why this is important can be found at
16+
[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall
17+
guiding principle here is that changelogs are for humans, not machines.
18+
19+
When reviewing merged PR's the labels to be used are:
20+
21+
* breaking - Used when the PR is considered a breaking change.
22+
* enhancement - Used when the PR adds a new feature or enhancement.
23+
* bug - Used when the PR fixes a bug included in a previous release.
24+
* documentation - Used when the PR adds or updates documentation.
25+
* internal - Used for internal changes that still require a mention in the
26+
changelog/release notes.
27+
28+
29+
## Release
30+
31+
Once the prep work is completed, the actual release is straight forward:
32+
33+
* First ensure that you have `release-it` installed globally, generally done by
34+
using one of the following commands:
35+
36+
```
37+
# using https://volta.sh
38+
volta install release-it
39+
40+
# using Yarn
41+
yarn global add release-it
42+
43+
# using npm
44+
npm install --global release-it
45+
```
46+
47+
* Second, ensure that you have installed your projects dependencies:
48+
49+
```
50+
yarn install
51+
```
52+
53+
* And last (but not least 😁) do your release. It requires a
54+
[GitHub personal access token](https://github.com/settings/tokens) as
55+
`$GITHUB_AUTH` environment variable. Only "repo" access is needed; no "admin"
56+
or other scopes are required.
57+
58+
```
59+
export GITHUB_AUTH="f941e0..."
60+
release-it
61+
```
62+
63+
[release-it](https://github.com/release-it/release-it/) manages the actual
64+
release process. It will prompt you to to choose the version number after which
65+
you will have the chance to hand tweak the changelog to be used (for the
66+
`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging,
67+
pushing the tag and commits, etc.

package.json

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@
1010
"node": ">= 10.*"
1111
},
1212
"devDependencies": {
13-
"auto-changelog": "^2.0.0",
1413
"ember-cli": "~3.18.0",
1514
"eslint": "^7.0.0",
16-
"release-it": "*"
15+
"lerna-changelog": "^1.0.1",
16+
"release-it": "*",
17+
"release-it-lerna-changelog": "^2.3.0"
1718
},
1819
"keywords": [
1920
"ember-addon",
@@ -23,23 +24,29 @@
2324
"license": "MIT",
2425
"author": "Luke Melia and the Yapp team",
2526
"dependencies": {
26-
"ember-cli-deploy-lightning-pack": "^3.0.0",
27+
"ember-cli-deploy-lightning-pack": "^3.0.1",
2728
"ember-cli-deploy-slack": "^1.0.0",
2829
"rsvp": "^4.8.5"
2930
},
3031
"ember-addon": {
3132
"defaultBlueprint": "yapp-deploy-config"
3233
},
3334
"release-it": {
34-
"hooks": {
35-
"after:bump": "npx auto-changelog -p"
36-
},
3735
"git": {
38-
"changelog": "npx auto-changelog --stdout --commit-limit false --unreleased --template https://raw.githubusercontent.com/release-it/release-it/master/templates/changelog-compact.hbs",
39-
"requireCleanWorkingDir": false
36+
"tagName": "v${version}",
37+
"commitMessage": "v${version}",
38+
"pushArgs": "--follow-tags --no-verify"
39+
},
40+
"npm": {
41+
"publish": false
4042
},
4143
"github": {
4244
"release": true
45+
},
46+
"plugins": {
47+
"release-it-lerna-changelog": {
48+
"infile": "CHANGELOG.md"
49+
}
4350
}
4451
}
4552
}

0 commit comments

Comments
 (0)