This repository has been archived by the owner on Feb 6, 2021. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
1,130 additions
and
94 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Release | ||
|
||
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 | ||
remaining task prior to releasing is confirming that all pull requests that | ||
have been merged since the last release have been labeled with the appropriate | ||
`lerna-changelog` labels and the titles have been updated to ensure they | ||
represent something that would make sense to our users. Some great information | ||
on why this is important can be found at | ||
[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall | ||
guiding principles here is that changelogs are for humans, not machines. | ||
|
||
When reviewing merged PR's the labels to be used are: | ||
|
||
* breaking - Used when the PR is considered a breaking change. | ||
* enhancement - Used when the PR adds a new feature or enhancement. | ||
* bug - Used when the PR fixes a bug included in a previous release. | ||
* documentation - Used when the PR adds or updates documentation. | ||
* 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: | ||
|
||
``` | ||
# using https://volta.sh | ||
volta install release-it | ||
# using Yarn | ||
yarn global add release-it | ||
# using npm | ||
npm install --global release-it | ||
``` | ||
|
||
* Second, ensure that you have installed your projects dependencies: | ||
|
||
``` | ||
# using yarn | ||
yarn install | ||
# using npm | ||
npm install | ||
``` | ||
|
||
* And last (but not least 😁) do your release: | ||
|
||
``` | ||
release-it | ||
``` | ||
|
||
[release-it](https://github.com/release-it/release-it/) manages the actual | ||
release process. It will prompt you through the process of choosing the version | ||
number, tagging, pushing the tag and commits, etc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,6 +2,17 @@ | |
"name": "ember-cli-htmlbars-inline-precompile", | ||
"version": "2.1.0", | ||
"description": "Precompile inline HTMLBars templates via ES6 tagged template strings", | ||
"keywords": [ | ||
"ember-addon", | ||
"ember-cli" | ||
], | ||
"repository": "https://github.com/ember-cli/ember-cli-htmlbars-inline-precompile", | ||
"license": "MIT", | ||
"author": "Clemens Müller <[email protected]>", | ||
"directories": { | ||
"doc": "doc", | ||
"test": "tests" | ||
}, | ||
"scripts": { | ||
"build": "ember build", | ||
"changelog": "lerna-changelog", | ||
|
@@ -14,8 +25,12 @@ | |
"test:node": "mocha node-tests/*.js", | ||
"test:node:debug": "mocha debug node-tests/*.js" | ||
}, | ||
"engines": { | ||
"node": "8.* || 10.* || >= 12.*" | ||
"dependencies": { | ||
"babel-plugin-htmlbars-inline-precompile": "^2.0.0", | ||
"ember-cli-version-checker": "^3.1.3", | ||
"hash-for-dep": "^1.5.1", | ||
"heimdalljs-logger": "^0.1.9", | ||
"silent-error": "^1.1.0" | ||
}, | ||
"devDependencies": { | ||
"@ember/optional-features": "^0.7.0", | ||
|
@@ -46,31 +61,34 @@ | |
"loader.js": "^4.7.0", | ||
"mocha": "^6.2.0", | ||
"qunit-dom": "^0.8.5", | ||
"release-it": "^12.2.1", | ||
"release-it-lerna-changelog": "^1.0.3", | ||
"username-sync": "^1.0.2" | ||
}, | ||
"keywords": [ | ||
"ember-addon", | ||
"ember-cli" | ||
], | ||
"repository": "https://github.com/ember-cli/ember-cli-htmlbars-inline-precompile", | ||
"license": "MIT", | ||
"author": "Clemens Müller <[email protected]>", | ||
"directories": { | ||
"doc": "doc", | ||
"test": "tests" | ||
}, | ||
"dependencies": { | ||
"babel-plugin-htmlbars-inline-precompile": "^2.0.0", | ||
"ember-cli-version-checker": "^3.1.3", | ||
"hash-for-dep": "^1.5.1", | ||
"heimdalljs-logger": "^0.1.9", | ||
"silent-error": "^1.1.0" | ||
}, | ||
"peerDependencies": { | ||
"ember-cli-babel": "^7.0.0" | ||
}, | ||
"engines": { | ||
"node": "8.* || 10.* || >= 12.*" | ||
}, | ||
"publishConfig": { | ||
"registry": "https://registry.npmjs.org" | ||
}, | ||
"ember-addon": { | ||
"configPath": "tests/dummy/config", | ||
"after": "ember-cli-htmlbars" | ||
}, | ||
"release-it": { | ||
"plugins": { | ||
"release-it-lerna-changelog": { | ||
"infile": "CHANGELOG.md" | ||
} | ||
}, | ||
"git": { | ||
"tagName": "v${version}" | ||
}, | ||
"github": { | ||
"release": true | ||
} | ||
} | ||
} |
Oops, something went wrong.