Skip to content

Commit 262b510

Browse files
committed
Simplify release setup and incorporate docs deploy
1 parent 7e5f87d commit 262b510

File tree

10 files changed

+72
-68
lines changed

10 files changed

+72
-68
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88
/bower_components/
99
/node_modules/
1010

11+
# *.md copies from release
12+
/packages/ember-cli-mirage/README.md
13+
/packages/ember-cli-mirage/LICENSE.md
14+
1115
# misc
1216
/.env*
1317
/.pnp*

CHANGELOG.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Ember CLI Mirage Change log
2+
3+
Releases (along with upgrade instructions) are documented on the Github [Releases](https://github.com/miragejs/ember-cli-mirage/releases) page.

LICENSE.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

LICENSE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Ember CLI Mirage
2+
3+
[![Build Status](https://github.com/miragejs/ember-cli-mirage/actions/workflows/ci.yml/badge.svg)](https://github.com/miragejs/ember-cli-mirage/actions/workflows/ci.yml)
4+
[![npm version](https://badge.fury.io/js/ember-cli-mirage.svg)](http://badge.fury.io/js/ember-cli-mirage)
5+
[![Ember Observer Score](http://emberobserver.com/badges/ember-cli-mirage.svg)](http://emberobserver.com/addons/ember-cli-mirage)
6+
7+
A client-side server to develop, test and prototype your Ember CLI app.
8+
9+
[View the docs here.](https://www.ember-cli-mirage.com/)
10+
11+
----
12+
13+
## Compatibility
14+
15+
* Ember.js v3.12 or above
16+
* Ember CLI v3.12 or above
17+
* Node.js v14 or above
18+
19+
## Installation
20+
21+
```sh
22+
ember install ember-cli-mirage
23+
```
24+
25+
## Feature requests
26+
27+
Please open an issue and add a :+1: emoji reaction. We will use the number of reactions as votes to indicate community interest, which will in turn help us prioritize feature development.
28+
29+
You can view the most-upvoted feature requests with [this link](https://github.com/miragejs/ember-cli-mirage/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3A%22Feature+%2F+Enhancement%22).
30+
31+
## Support
32+
33+
Having trouble?
34+
35+
- **Join #ec-mirage** on the [Ember Community Discord server](https://discord.gg/zT3asNS)
36+
- **Open an issue**, and if possible reproduce it using the [Mirage Boilerplate Twiddle](https://ember-twiddle.com/ec3a4c625c43e7a38f3c6c0c1b8232ec?openFiles=twiddle.json%2C).
37+
38+
## Contributing
39+
40+
Have a look at our [Contributing guidelines](./CONTRIBUTING.md).
41+
42+
## About
43+
44+
This library is developed and maintained by [EmberMap](https://embermap.com/). We have a [Mirage tips and tricks](https://embermap.com/topics/mirage-tips-and-tricks) video series if you're looking to learn how to get the most out of Mirage.
45+
46+
Thanks to all our amazing [contributors](https://github.com/miragejs/ember-cli-mirage/graphs/contributors)!

RELEASE.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,10 @@ Once the prep work is completed, the actual release is straight forward:
5353
yarn release
5454
```
5555

56-
* Push the changes to GitHub and let CI publish the actual package to the registry:
57-
58-
```sh
59-
git push origin --follow-tags
60-
```
61-
6256
[release-it](https://github.com/release-it/release-it/) manages the actual
6357
release process. It will prompt you to choose the version number after which
6458
you will have the chance to hand tweak the changelog to be used (for the
6559
`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging,
6660
pushing the tag and commits, etc.
61+
62+
From there, [CI](./.github/workflows/publish.yml) will take of publishing the actual package to the npm registry.

package.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@
3535
"registry": "https://registry.npmjs.org"
3636
},
3737
"release-it": {
38+
"hooks": {
39+
"before:init": "cp CHANGELOG.md LICENSE.md README.md packages/ember-cli-mirage/",
40+
"after:release": "cd packages/ember-cli-mirage-docs && yarn deploy"
41+
},
3842
"plugins": {
3943
"release-it-lerna-changelog": {
4044
"infile": "CHANGELOG.md",
@@ -48,10 +52,12 @@
4852
"additionalManifests": {
4953
"dependencyUpdates": [
5054
"package.json",
55+
"packages/ember-cli-mirage-docs/package.json",
5156
"test-packages/*/package.json"
5257
],
5358
"versionUpdates": [
54-
"package.json"
59+
"package.json",
60+
"packages/ember-cli-mirage-docs/package.json"
5561
]
5662
}
5763
}

packages/ember-cli-mirage-docs/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
},
2222
"scripts": {
2323
"build": "ember build --environment=production",
24+
"deploy": "ember deploy production",
2425
"lint": "npm-run-all --aggregate-output --continue-on-error --parallel \"lint:!(fix)\"",
2526
"lint:fix": "npm-run-all --aggregate-output --continue-on-error --parallel lint:*:fix",
2627
"lint:hbs": "ember-template-lint .",

0 commit comments

Comments
 (0)