Skip to content

Commit

Permalink
chore: add shipjs (algolia/vue-instantsearch#794)
Browse files Browse the repository at this point in the history
* chore: add shipjs

* Update .circleci/config.yml

Co-authored-by: Haroen Viaene <hello@haroen.me>

* chore: remove old scripts

* docs: update release guide

Co-authored-by: Haroen Viaene <hello@haroen.me>
  • Loading branch information
Eunjae Lee and Haroenv authored Jun 18, 2020
1 parent 5e9e790 commit 9b120fc
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 115 deletions.
24 changes: 16 additions & 8 deletions packages/vue-instantsearch/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,29 @@ The project uses [conventional commit format](https://github.com/angular/angular
To release the library, the first step is to create a "release PR" by running:

```bash
yarn release:branch
yarn release
```

This will ask you the new version of the library, and update all the required files accordingly.
We use `git add --patch` on updated files to give you the opportunity to review the changes.
In general all you need to do is accept all of them by pressing `y` multiple times.
For that script to work, you need to provide `GITHUB_TOKEN` environment variable. You can either prepend it or put it in `.env` file.

```bash
GITHUB_TOKEN=xyz yarn release

At the end of the process, the release branch is pushed to GitHub where you can open the Pull Request.
or

Once the changes are approved you can merge it there.
echo "GITHUB_TOKEN=xyz" >> .env
yarn release
```

You can create a token at [GitHub](https://github.com/settings/tokens/new) with `Full control of private repositories` scope.

This will ask you the new version of the library, and update all the required files accordingly.
At the end of the process, the release branch is pushed to GitHub and a Pull Request is automatically created.

You can now fetch the latest changes from the remote master branch and run:
Once the changes are approved you can merge it there. Then CircleCI will be triggered and it will run

```bash
yarn release:publish
yarn shipjs trigger
```

This will:
Expand Down
4 changes: 2 additions & 2 deletions packages/vue-instantsearch/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@
"format": "prettier --write '**/*.{js,md,vue,css}'",
"changelog": "conventional-changelog --preset angular --infile CHANGELOG.md --same-file",
"changelog:unreleased": "conventional-changelog --preset angular --output-unreleased",
"release:branch": "scripts/release-branch.sh",
"release:publish": "scripts/release-publish.sh"
"release": "shipjs prepare"
},
"dependencies": {
"algoliasearch-helper": "^3.1.0",
Expand Down Expand Up @@ -100,6 +99,7 @@
"rollup-plugin-terser": "4.0.4",
"rollup-plugin-vue": "3.0.0",
"rollup-watch": "4.3.1",
"shipjs": "0.20.0-beta.3",
"vue": "2.5.18",
"vue-autosuggest": "1.8.1",
"vue-jest": "2.6.0",
Expand Down
11 changes: 0 additions & 11 deletions packages/vue-instantsearch/scripts/get-npm-tag.js

This file was deleted.

6 changes: 0 additions & 6 deletions packages/vue-instantsearch/scripts/get-version.js

This file was deleted.

50 changes: 0 additions & 50 deletions packages/vue-instantsearch/scripts/release-branch.sh

This file was deleted.

38 changes: 0 additions & 38 deletions packages/vue-instantsearch/scripts/release-publish.sh

This file was deleted.

0 comments on commit 9b120fc

Please sign in to comment.