Skip to content

Commit

Permalink
Address review comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
rwjblue committed Sep 21, 2020
1 parent 7c94995 commit eaecc2a
Show file tree
Hide file tree
Showing 6 changed files with 526 additions and 79 deletions.
File renamed without changes.
File renamed without changes.
39 changes: 16 additions & 23 deletions packages/ember-cli-code-coverage/RELEASE.md → RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# Release
# Release Process

Releases are mostly automated using
[release-it](https://github.com/release-it/release-it/) and
[lerna-changelog](https://github.com/lerna/lerna-changelog/).


## Preparation

Since the majority of the actual release process is automated, the primary
Expand All @@ -25,39 +24,33 @@ When reviewing merged PR's the labels to be used are:
* internal - Used for internal changes that still require a mention in the
changelog/release notes.


## Release

Once the prep work is completed, the actual release is straight forward:

* First ensure that you have `release-it` installed globally, generally done by
using one of the following commands:
* First, ensure that you have installed your projects dependencies:

```sh
yarn install
```
# using https://volta.sh
volta install release-it

# using Yarn
yarn global add release-it
* Second, ensure that you have obtained a
[GitHub personal access token][generate-token] with the `repo` scope (no
other permissions are needed). Make sure the token is available as the
`GITHUB_AUTH` environment variable.

# using npm
npm install --global release-it
```
For instance:

* Second, ensure that you have installed your projects dependencies:
```bash
export GITHUB_AUTH=abc123def456
```

```
yarn install
```
[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable

* And last (but not least 😁) do your release. It requires a
[GitHub personal access token](https://github.com/settings/tokens) as
`$GITHUB_AUTH` environment variable. Only "repo" access is needed; no "admin"
or other scopes are required.
* And last (but not least 😁) do your release.

```
export GITHUB_AUTH="f941e0..."
release-it
```sh
npx release-it
```

[release-it](https://github.com/release-it/release-it/) manages the actual
Expand Down
49 changes: 48 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
{
"private": true,
"repository": {
"type": "git",
"url": "[email protected]:kategengler/ember-cli-code-coverage.git"
},
"workspaces": [
"packages/*",
"test-packages/*"
Expand All @@ -12,6 +16,49 @@
"chai-files": "^1.4.0",
"execa": "^4.0.3",
"mocha": "^5.2.0",
"release-it": "^14.0.2",
"release-it-lerna-changelog": "^2.4.0",
"release-it-yarn-workspaces": "^1.5.0",
"rimraf": "^2.6.2"
},
"publishConfig": {
"registry": "https://registry.npmjs.org"
},
"changelog": {
"repo": "kategengler/ember-cli-code-coverage",
"labels": {
"breaking": ":boom: Breaking Change",
"enhancement": ":rocket: Enhancement",
"bug": ":bug: Bug Fix",
"documentation": ":memo: Documentation",
"internal": ":house: Internal"
}
},
"release-it": {
"plugins": {
"release-it-lerna-changelog": {
"infile": "CHANGELOG.md",
"launchEditor": true
},
"release-it-yarn-workspaces": {
"additionalManifests": {
"dependencyUpdates": [
"test-packages/*/package.json"
]
},
"publish": false,
"workspaces": [
"packages/*"
]
}
},
"git": {
"tagName": "v${version}"
},
"github": {
"release": true,
"tokenRef": "GITHUB_AUTH"
},
"npm": false
}
}
}
30 changes: 1 addition & 29 deletions packages/ember-cli-code-coverage/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"browser-test": "COVERAGE=true ember test",
"lint:hbs": "ember-template-lint .",
"lint:js": "eslint .",
"test": "npm run-script lint:js && npm run-script node-test"
"test": "npm run lint:js"
},
"dependencies": {
"babel-plugin-istanbul": "^6.0.0",
Expand Down Expand Up @@ -83,39 +83,11 @@
"publishConfig": {
"registry": "https://registry.npmjs.org"
},
"changelog": {
"repo": "kategengler/ember-cli-code-coverage",
"labels": {
"breaking": ":boom: Breaking Change",
"enhancement": ":rocket: Enhancement",
"bug": ":bug: Bug Fix",
"documentation": ":memo: Documentation",
"internal": ":house: Internal"
}
},
"ember": {
"edition": "octane"
},
"ember-addon": {
"configPath": "tests/dummy/config",
"before": "ember-cli-typescript"
},
"release-it": {
"plugins": {
"release-it-lerna-changelog": {
"infile": "CHANGELOG.md",
"launchEditor": true
}
},
"git": {
"tagName": "v${version}"
},
"github": {
"release": true,
"tokenRef": "GITHUB_AUTH"
},
"npm": {
"publish": false
}
}
}
Loading

0 comments on commit eaecc2a

Please sign in to comment.