From 262b510d3eddeda8e972c8a05201858484659334 Mon Sep 17 00:00:00 2001 From: Sergey Astapov Date: Tue, 3 May 2022 10:34:50 -0400 Subject: [PATCH] Simplify release setup and incorporate docs deploy --- .gitignore | 4 ++ CHANGELOG.md | 4 +- LICENSE.md | 10 ++++- README.md | 47 ++++++++++++++++++++- RELEASE.md | 8 +--- package.json | 8 +++- packages/ember-cli-mirage-docs/package.json | 1 + packages/ember-cli-mirage/CHANGELOG.md | 3 -- packages/ember-cli-mirage/LICENSE.md | 9 ---- packages/ember-cli-mirage/README.md | 46 -------------------- 10 files changed, 72 insertions(+), 68 deletions(-) mode change 120000 => 100644 CHANGELOG.md mode change 120000 => 100644 LICENSE.md mode change 120000 => 100644 README.md delete mode 100644 packages/ember-cli-mirage/CHANGELOG.md delete mode 100644 packages/ember-cli-mirage/LICENSE.md delete mode 100644 packages/ember-cli-mirage/README.md diff --git a/.gitignore b/.gitignore index 302b621a7..9bbe537c7 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,10 @@ /bower_components/ /node_modules/ +# *.md copies from release +/packages/ember-cli-mirage/README.md +/packages/ember-cli-mirage/LICENSE.md + # misc /.env* /.pnp* diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 120000 index 15b3a7cb2..000000000 --- a/CHANGELOG.md +++ /dev/null @@ -1 +0,0 @@ -packages/ember-cli-mirage/CHANGELOG.md \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..0ee0feb95 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# Ember CLI Mirage Change log + +Releases (along with upgrade instructions) are documented on the Github [Releases](https://github.com/miragejs/ember-cli-mirage/releases) page. diff --git a/LICENSE.md b/LICENSE.md deleted file mode 120000 index 1da14e3f9..000000000 --- a/LICENSE.md +++ /dev/null @@ -1 +0,0 @@ -packages/ember-cli-mirage/LICENSE.md \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 000000000..02000b56e --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,9 @@ +The MIT License (MIT) + +Copyright (c) 2016 + +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: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +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. diff --git a/README.md b/README.md deleted file mode 120000 index c6be603e0..000000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -packages/ember-cli-mirage/README.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 000000000..1a694aedb --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Ember CLI Mirage + +[![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) +[![npm version](https://badge.fury.io/js/ember-cli-mirage.svg)](http://badge.fury.io/js/ember-cli-mirage) +[![Ember Observer Score](http://emberobserver.com/badges/ember-cli-mirage.svg)](http://emberobserver.com/addons/ember-cli-mirage) + +A client-side server to develop, test and prototype your Ember CLI app. + +[View the docs here.](https://www.ember-cli-mirage.com/) + +---- + +## Compatibility + +* Ember.js v3.12 or above +* Ember CLI v3.12 or above +* Node.js v14 or above + +## Installation + +```sh +ember install ember-cli-mirage +``` + +## Feature requests + +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. + +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). + +## Support + +Having trouble? + +- **Join #ec-mirage** on the [Ember Community Discord server](https://discord.gg/zT3asNS) +- **Open an issue**, and if possible reproduce it using the [Mirage Boilerplate Twiddle](https://ember-twiddle.com/ec3a4c625c43e7a38f3c6c0c1b8232ec?openFiles=twiddle.json%2C). + +## Contributing + +Have a look at our [Contributing guidelines](./CONTRIBUTING.md). + +## About + +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. + +Thanks to all our amazing [contributors](https://github.com/miragejs/ember-cli-mirage/graphs/contributors)! diff --git a/RELEASE.md b/RELEASE.md index 7cc7ae4f2..040b0860a 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -53,14 +53,10 @@ Once the prep work is completed, the actual release is straight forward: yarn release ``` -* Push the changes to GitHub and let CI publish the actual package to the registry: - - ```sh - git push origin --follow-tags - ``` - [release-it](https://github.com/release-it/release-it/) manages the actual release process. It will prompt you to choose the version number after which you will have the chance to hand tweak the changelog to be used (for the `CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging, pushing the tag and commits, etc. + +From there, [CI](./.github/workflows/publish.yml) will take of publishing the actual package to the npm registry. diff --git a/package.json b/package.json index b55214d4d..66210f2fa 100644 --- a/package.json +++ b/package.json @@ -35,6 +35,10 @@ "registry": "https://registry.npmjs.org" }, "release-it": { + "hooks": { + "before:init": "cp CHANGELOG.md LICENSE.md README.md packages/ember-cli-mirage/", + "after:release": "cd packages/ember-cli-mirage-docs && yarn deploy" + }, "plugins": { "release-it-lerna-changelog": { "infile": "CHANGELOG.md", @@ -48,10 +52,12 @@ "additionalManifests": { "dependencyUpdates": [ "package.json", + "packages/ember-cli-mirage-docs/package.json", "test-packages/*/package.json" ], "versionUpdates": [ - "package.json" + "package.json", + "packages/ember-cli-mirage-docs/package.json" ] } } diff --git a/packages/ember-cli-mirage-docs/package.json b/packages/ember-cli-mirage-docs/package.json index df883e298..8c9ad8123 100644 --- a/packages/ember-cli-mirage-docs/package.json +++ b/packages/ember-cli-mirage-docs/package.json @@ -21,6 +21,7 @@ }, "scripts": { "build": "ember build --environment=production", + "deploy": "ember deploy production", "lint": "npm-run-all --aggregate-output --continue-on-error --parallel \"lint:!(fix)\"", "lint:fix": "npm-run-all --aggregate-output --continue-on-error --parallel lint:*:fix", "lint:hbs": "ember-template-lint .", diff --git a/packages/ember-cli-mirage/CHANGELOG.md b/packages/ember-cli-mirage/CHANGELOG.md deleted file mode 100644 index 0ee0feb95..000000000 --- a/packages/ember-cli-mirage/CHANGELOG.md +++ /dev/null @@ -1,3 +0,0 @@ -# Ember CLI Mirage Change log - -Releases (along with upgrade instructions) are documented on the Github [Releases](https://github.com/miragejs/ember-cli-mirage/releases) page. diff --git a/packages/ember-cli-mirage/LICENSE.md b/packages/ember-cli-mirage/LICENSE.md deleted file mode 100644 index 02000b56e..000000000 --- a/packages/ember-cli-mirage/LICENSE.md +++ /dev/null @@ -1,9 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2016 - -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: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -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. diff --git a/packages/ember-cli-mirage/README.md b/packages/ember-cli-mirage/README.md deleted file mode 100644 index 1a694aedb..000000000 --- a/packages/ember-cli-mirage/README.md +++ /dev/null @@ -1,46 +0,0 @@ -# Ember CLI Mirage - -[![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) -[![npm version](https://badge.fury.io/js/ember-cli-mirage.svg)](http://badge.fury.io/js/ember-cli-mirage) -[![Ember Observer Score](http://emberobserver.com/badges/ember-cli-mirage.svg)](http://emberobserver.com/addons/ember-cli-mirage) - -A client-side server to develop, test and prototype your Ember CLI app. - -[View the docs here.](https://www.ember-cli-mirage.com/) - ----- - -## Compatibility - -* Ember.js v3.12 or above -* Ember CLI v3.12 or above -* Node.js v14 or above - -## Installation - -```sh -ember install ember-cli-mirage -``` - -## Feature requests - -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. - -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). - -## Support - -Having trouble? - -- **Join #ec-mirage** on the [Ember Community Discord server](https://discord.gg/zT3asNS) -- **Open an issue**, and if possible reproduce it using the [Mirage Boilerplate Twiddle](https://ember-twiddle.com/ec3a4c625c43e7a38f3c6c0c1b8232ec?openFiles=twiddle.json%2C). - -## Contributing - -Have a look at our [Contributing guidelines](./CONTRIBUTING.md). - -## About - -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. - -Thanks to all our amazing [contributors](https://github.com/miragejs/ember-cli-mirage/graphs/contributors)!