Skip to content

Commit e949370

Browse files
committed
Revert "Switch from release-it to release-plan"
This reverts commit 8827179.
1 parent 8827179 commit e949370

File tree

7 files changed

+1293
-618
lines changed

7 files changed

+1293
-618
lines changed

.github/workflows/plan-release.yml

Lines changed: 0 additions & 94 deletions
This file was deleted.

.github/workflows/publish.yml

Lines changed: 0 additions & 43 deletions
This file was deleted.

RELEASE.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

ember-file-upload/CHANGELOG.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Changelog
2-
31

42

53

ember-file-upload/RELEASE.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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 principles 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+
# using yarn
51+
yarn install
52+
53+
# using npm
54+
npm install
55+
```
56+
57+
* And last (but not least 😁) do your release. It requires a
58+
[GitHub personal access token](https://github.com/settings/tokens) as
59+
`$GITHUB_AUTH` environment variable. Only "repo" access is needed; no "admin"
60+
or other scopes are required.
61+
62+
```
63+
export GITHUB_AUTH="f941e0..."
64+
release-it
65+
```
66+
67+
[release-it](https://github.com/release-it/release-it/) manages the actual
68+
release process. It will prompt you through the process of choosing the version
69+
number, tagging, pushing the tag and commits, etc.

package.json

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
{
2-
"version": "9.4.0",
32
"private": true,
4-
"repository": "https://github.com/adopted-ember-addons/ember-file-upload",
53
"scripts": {
64
"ember-try-one": "pnpm -F test-app ember-try-one",
75
"release": "pnpm prepare && pnpm -F ember-file-upload release",
@@ -17,14 +15,39 @@
1715
"test:watch:addon": "pnpm -F ember-file-upload start",
1816
"website": "pnpm --filter website start"
1917
},
18+
"repository": "https://github.com/adopted-ember-addons/ember-file-upload",
2019
"devDependencies": {
20+
"@release-it-plugins/lerna-changelog": "^6.1.0",
21+
"@release-it-plugins/workspaces": "^4.2.0",
2122
"npm-run-all": "^4.1.5",
22-
"release-plan": "^0.16.0"
23+
"release-it": "^17.0.0"
24+
},
25+
"release-it": {
26+
"plugins": {
27+
"@release-it-plugins/workspaces": {
28+
"workspaces": [
29+
"ember-file-upload"
30+
]
31+
},
32+
"@release-it-plugins/lerna-changelog": {
33+
"infile": "CHANGELOG.md",
34+
"launchEditor": true
35+
}
36+
},
37+
"git": {
38+
"tagName": "v${version}"
39+
},
40+
"github": {
41+
"release": true,
42+
"tokenRef": "GITHUB_AUTH"
43+
},
44+
"npm": false
2345
},
24-
"packageManager": "[email protected]",
2546
"pnpm": {
2647
"overrides": {
2748
"@glimmer/validator": "^0.92.0"
2849
}
29-
}
50+
},
51+
"version": "9.4.0",
52+
"packageManager": "[email protected]"
3053
}

0 commit comments

Comments
 (0)