Merge branch 'main' into fix/changelog-dir

algolia · Nov 6, 2020 · fa13d82 · fa13d82
2 parents 4f69b44 + 67d45f0
commit fa13d82
Show file tree

Hide file tree

Showing 112 changed files with 3,991 additions and 3,035 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -88,6 +88,33 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "heavenshell",
+      "name": "Shinya Ohyanagi",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/56591?v=4",
+      "profile": "https://github.com/heavenshell",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "donghoon-song",
+      "name": "Donghoon Song",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/32301380?v=4",
+      "profile": "https://donghoon-song.github.io",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "miyajan",
+      "name": "Miyata Jumpei",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/945853?v=4",
+      "profile": "https://github.com/miyajan",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7

diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -28,7 +28,7 @@ aliases:
 defaults: &defaults
   working_directory: ~/repo
   docker:
-    - image: circleci/node:8.16.2
+    - image: circleci/node:12.18.0
 
 version: 2
 jobs:
@@ -59,8 +59,8 @@ jobs:
           command: |
             git config --global user.email "karis612@gmail.com"
             git config --global user.name "Eunjae Lee"
-            yarn release:prepare --yes --no-browse
-  release_if_needed:
+            yarn run release --yes --no-browse
+  shipjs_trigger:
     <<: *defaults
     steps:
       - checkout
@@ -69,8 +69,8 @@ jobs:
       - run: *run_yarn_install
       - save_cache: *save_yarn_cache
       - run:
-          name: Try to Release
-          command: yarn release:trigger
+          name: Triggering Ship.js to Release
+          command: yarn shipjs trigger
   gh_pages:
     <<: *defaults
     steps:
@@ -90,27 +90,27 @@ workflows:
   ci:
     jobs:
       - test
-      - release_if_needed:
+      - shipjs_trigger:
           requires:
             - test
           filters:
             branches:
               only:
-                - master
+                - main
   gh_pages:
     jobs:
       - gh_pages:
           filters:
             branches:
               only:
-                - master
+                - main
   prepare_release_every_tuesday:
     triggers:
       - schedule:
           cron: "0 9 * * 2"
           filters:
             branches:
               only:
-                - master
+                - main
     jobs:
       - prepare_release
diff --git a/.node-version b/.node-version
@@ -1 +1 @@
-8.16.0
+12.18.0
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-12.16.1
+12.18.0
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1 @@
+website/reference/all-config.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,236 @@
+# [0.22.0](https://github.com/algolia/shipjs/compare/v0.21.1...v0.22.0) (2020-09-28)
+
+
+### Bug Fixes
+
+* typo in GitHubAction config ([#928](https://github.com/algolia/shipjs/issues/928)) ([489647d](https://github.com/algolia/shipjs/commit/489647da63b6208497014d5eb276d5b09ebb9d1a))
+
+
+### Features
+
+* understands `--config <FILE>` option in `conventionalChangelogArgs` ([#927](https://github.com/algolia/shipjs/issues/927)) ([06c7226](https://github.com/algolia/shipjs/commit/06c7226fa66185edd23f6626b6a2b8b7df1d93b6))
+
+
+
+## [0.21.1](https://github.com/algolia/shipjs/compare/v0.21.0...v0.21.1) (2020-09-23)
+
+
+### Bug Fixes
+
+* **setup:** add --tag to publish command in generated config ([#916](https://github.com/algolia/shipjs/issues/916)) ([53121e2](https://github.com/algolia/shipjs/commit/53121e22292df864413dff36238ad2daf1ae17c9))
+* **trigger:** replace yarn publish with npm publish ([#919](https://github.com/algolia/shipjs/issues/919)) ([66149dc](https://github.com/algolia/shipjs/commit/66149dc4da2884a57dca03296fbc24262843964a))
+* **trigger:** set npm config to read NPM_AUTH_TOKEN ([#923](https://github.com/algolia/shipjs/issues/923)) ([1c935a3](https://github.com/algolia/shipjs/commit/1c935a354fb167a3fd5bc9587c857ec338df59db))
+
+
+
+# [0.21.0](https://github.com/algolia/shipjs/compare/v0.20.1...v0.21.0) (2020-08-24)
+
+
+### Features
+
+* add basic support for esm ([#914](https://github.com/algolia/shipjs/issues/914)) ([42918d5](https://github.com/algolia/shipjs/commit/42918d5e3b1a57ef4096b2ddeb67282075aa01ea))
+
+
+
+## [0.20.1](https://github.com/algolia/shipjs/compare/v0.20.0...v0.20.1) (2020-06-22)
+
+
+### Bug Fixes
+
+* **setup:** improve GitHub Actions flow made with ([#904](https://github.com/algolia/shipjs/issues/904)) ([066ff50](https://github.com/algolia/shipjs/commit/066ff50d9461d39c684fe17a153dcd2573608cd2))
+
+
+
+# [0.20.0](https://github.com/algolia/shipjs/compare/v0.19.0...v0.20.0) (2020-06-16)
+
+
+### BREAKING CHANGE
+
+<img src="./assets/breaking-change.png" alt="BREAKING CHANGE" title="BREAKING CHANGE" width=250 height=60 />
+
+From this version, `mergeStrategy` no longer exists.
+
+### If you don't know what it is,
+
+Make sure you run `shipjs trigger` only on the branches you've specified.
+
+If you have a CircleCI config like the following:
+
+```yaml
+version: 2
+jobs:
+  shipjs_trigger:
+    docker:
+      - image: "circleci/node:latest"
+    steps:
+      - checkout
+      - run:
+          name: Install
+          command: yarn install
+      - run:
+          name: Triggering Ship.js to Release
+          command: yarn shipjs trigger
+workflows:
+  version: 2
+  release_if_needed:
+    jobs:
+      - shipjs_trigger
+```
+
+then, modify the last part like the following:
+
+```yaml
+workflows:
+  version: 2
+  release_if_needed:
+    jobs:
+      - shipjs_trigger:
+          filters:
+            branches:
+              only:
+                - master # or whatever branch you'd like (normally your base branch)
+```
+
+This ensures `shipjs trigger` runs only on the specified branches.
+
+### If you were using `mergeStrategy`,
+
+Ship.js used to have `toSameBranch` and `toReleaseBranch` strategies. Now they're gone and it only works like `toSameBranch` strategy. As explained above, you need to specify branches where to run `shipjs trigger`, though.
+
+If you were using `toReleaseBranch`, there is a workaround. You can read [Release Snapshot](https://community.algolia.com/shipjs/guide/useful-config.html#release-snapshot) to achieve what you used to do.
+
+
+### Bug Fixes
+
+* **prepare:** return correct releaseType ([#885](https://github.com/algolia/shipjs/issues/885)) ([7d918f6](https://github.com/algolia/shipjs/commit/7d918f6851bec175ab4f98f91f439ee7cfdb19c9))
+* **setup:** get correct remote branches ([#883](https://github.com/algolia/shipjs/issues/883)) ([551dde0](https://github.com/algolia/shipjs/commit/551dde0656131b52de66020afa68bc53aa0b71ae))
+* **setup:** update circleci node version to v12 ([#884](https://github.com/algolia/shipjs/issues/884)) ([6579294](https://github.com/algolia/shipjs/commit/6579294b8d884634a72b29bca4a01dcede232f7e))
+* **setup:** use current branch when there is no remote at setup flow ([#881](https://github.com/algolia/shipjs/issues/881)) ([5a0e152](https://github.com/algolia/shipjs/commit/5a0e15224a6ecbe6ec4a909b998a11bc03b28799))
+
+
+# [0.19.0](https://github.com/algolia/shipjs/compare/v0.18.4...v0.19.0) (2020-05-12)
+
+
+### Features
+
+* force push to protected branch with explicit config ([#813](https://github.com/algolia/shipjs/issues/813)) ([3647853](https://github.com/algolia/shipjs/commit/364785329d128ff95f4a9b0f31ec83fd5e27f0c7))
+
+
+
+## [0.18.4](https://github.com/algolia/shipjs/compare/v0.18.3...v0.18.4) (2020-05-08)
+
+
+### Bug Fixes
+
+* **actions:** fix ejs syntax ([#801](https://github.com/algolia/shipjs/issues/801)) ([8055a9f](https://github.com/algolia/shipjs/commit/8055a9f5ce7d4d4f6d904dd096e4a244e2676f9d))
+* **release:** push to correct branch in toReleaseBranch strategy ([#803](https://github.com/algolia/shipjs/issues/803)) ([1367315](https://github.com/algolia/shipjs/commit/1367315976244289ccb66c8c8d96ee62d421418f))
+
+
+
+## [0.18.3](https://github.com/algolia/shipjs/compare/v0.18.2...v0.18.3) (2020-05-04)
+
+
+### Bug Fixes
+
+* **actions:** add fetch-depth and git fetch ([#778](https://github.com/algolia/shipjs/issues/778)) ([994e4ff](https://github.com/algolia/shipjs/commit/994e4ff8177a6cb7e74a27c2dc0dab03ba512a5c))
+* **deps:** update dependency shelljs to v0.8.4 ([#776](https://github.com/algolia/shipjs/issues/776)) ([b70fc24](https://github.com/algolia/shipjs/commit/b70fc244ec3d1f653777e436b1ac3f4ffea0bf6c))
+* **release:** skip running publishCommand if nullish ([#793](https://github.com/algolia/shipjs/issues/793)) ([eb62c8d](https://github.com/algolia/shipjs/commit/eb62c8dfa500888587172e796538d12238dc7a10))
+
+
+
+## [0.18.2](https://github.com/algolia/shipjs/compare/v0.18.1...v0.18.2) (2020-04-07)
+
+
+### Bug Fixes
+
+* **prepare:** fix wrong comparison url in the PR summary when getTagName is overridden in ship.config.js ([#753](https://github.com/algolia/shipjs/issues/753)) ([4a40920](https://github.com/algolia/shipjs/commit/4a40920e7874b51b6c324a8a23ae7690c87159fc))
+
+
+
+## [0.18.1](https://github.com/algolia/shipjs/compare/v0.18.0...v0.18.1) (2020-04-03)
+
+
+### Bug Fixes
+
+* **deps:** update dependency prettier to v2 ([#732](https://github.com/algolia/shipjs/issues/732)) ([96d6ff2](https://github.com/algolia/shipjs/commit/96d6ff22214849b7c0c665b3d104b00ded43b38a))
+* **prepare:** respect custom tag name when getting a revision range ([#751](https://github.com/algolia/shipjs/issues/751)) ([a1baa93](https://github.com/algolia/shipjs/commit/a1baa93927a11dfe6f96b9c40fc80e9f54f51e32))
+
+
+
+# [0.18.0](https://github.com/algolia/shipjs/compare/v0.17.0...v0.18.0) (2020-03-17)
+
+
+### Bug Fixes
+
+* **setup:** use github-actions[bot] name and email for generated pull requests ([#719](https://github.com/algolia/shipjs/issues/719)) ([ea4571e](https://github.com/algolia/shipjs/commit/ea4571e82cb4199e788c12f9b0db743814e06931))
+
+
+### Features
+
+* **prepare:** add a new hook `getNextVersion` ([#724](https://github.com/algolia/shipjs/issues/724)) ([21cf827](https://github.com/algolia/shipjs/commit/21cf8273319871e84ddfe4ef3c56333228ce72a7))
+
+
+
+# [0.17.0](https://github.com/algolia/shipjs/compare/v0.16.1...v0.17.0) (2020-03-06)
+
+### BREAKING CHANGE
+
+<img src="./assets/breaking-change.png" alt="BREAKING CHANGE" title="BREAKING CHANGE" width=250 height=60 />
+
+This version introduces some breaking changes.
+
+* In your `ship.config.js`, rename `pullRequestReviewer` to `pullRequestReviewers` (which accepts only an array of strings).
+
+* In your `ship.config.js`, rename `pullRequestTeamReviewer` to `pullRequestTeamReviewers` (which accepts only an array of strings).
+
+* `releaseStart` for Slack message has been removed. If you'd like to have it back, please create an issue and let's discuss.
+
+* The default value of `testCommandBeforeRelease` is now `undefined`. It used to be `({ isYarn }) => isYarn ? 'yarn test' : 'npm run test'`. This change assumes many of you already run tests with CI services when you create pull requests. With the previous config, Ship.js unnecessarily ran tests before release. If you'd like to have it back, add some config like the following:
+
+```
+testCommandBeforeRelease: ({ isYarn }) => isYarn ? 'yarn test' : 'npm run test',
+```
+
+
+### Bug Fixes
+
+* **setup:** do not write ship.config.js if not necessary ([#705](https://github.com/algolia/shipjs/issues/705)) ([82f8cbc](https://github.com/algolia/shipjs/commit/82f8cbca1ce3b87cf629f83c95202c2cde3f5b49))
+* **setup:** fix wrong config(packagesToBump, packagesToPublish) for monorepo ([#701](https://github.com/algolia/shipjs/issues/701)) ([0590a38](https://github.com/algolia/shipjs/commit/0590a384d036ff13586d744b6cadc103dd6ef0da))
+
+* clean up reviewer related configs ([#707](https://github.com/algolia/shipjs/issues/707)) ([833d684](https://github.com/algolia/shipjs/commit/833d684d516bf75bdc3ae62c634ff1c8b7e3340c))
+* allow @(a|b|c) syntax for packagesToBump and packagesToPublish ([#702](https://github.com/algolia/shipjs/issues/702)) ([de9083c](https://github.com/algolia/shipjs/commit/de9083c95066bd998c9b0071ddd9bd682f270700))
+* remove releaseStart hook for slack message ([#703](https://github.com/algolia/shipjs/issues/703)) ([2a9502b](https://github.com/algolia/shipjs/commit/2a9502b75c94406db7dff3a6779f07215b6731ca))
+* create CHANGELOG if missing ([#697](https://github.com/algolia/shipjs/issues/697)) ([72cb4ec](https://github.com/algolia/shipjs/commit/72cb4eca2ad43c4d1d62b8e427233f283d5a0a73))
+* empty testCommandBeforeRelease by default ([#696](https://github.com/algolia/shipjs/issues/696)) ([34753b0](https://github.com/algolia/shipjs/commit/34753b061a6f73f6a72218fa703bdf99237cefc7))
+* **shipjs-lib:** exclude dependencies from final bundle ([#651](https://github.com/algolia/shipjs/issues/651)) ([f6ec4cf](https://github.com/algolia/shipjs/commit/f6ec4cfff0ae578fff54f7e6f23367839dfb3cc1))
+* check nullable value for reviewers ([#709](https://github.com/algolia/shipjs/issues/709)) ([df7c0be](https://github.com/algolia/shipjs/commit/df7c0be8f25655727b52c54b53f997745d3e32fe))
+
+
+
+## [0.16.1](https://github.com/algolia/shipjs/compare/v0.16.0...v0.16.1) (2020-03-03)
+
+
+### Bug Fixes
+
+* **setup:** use .prettierrc if exists ([#681](https://github.com/algolia/shipjs/issues/681)) ([39b93be](https://github.com/algolia/shipjs/commit/39b93be68d371ef3b762e2ee16505170ae758430))
+
+
+
+# [0.16.0](https://github.com/algolia/shipjs/compare/v0.15.0...v0.16.0) (2020-02-25)
+
+
+### Bug Fixes
+
+* detect major versions correctly ([#666](https://github.com/algolia/shipjs/issues/666)) ([5c5cca1](https://github.com/algolia/shipjs/commit/5c5cca180a37a163bef53df28d222c923eab87c2)), closes [#634](https://github.com/algolia/shipjs/issues/634)
+* pass version to buildCommand ([#676](https://github.com/algolia/shipjs/issues/676)) ([c25b49b](https://github.com/algolia/shipjs/commit/c25b49b8d8c70d649b04e151e9898515e064fa47))
+
+
+### Features
+
+* **error:** tell user where to create a GitHub token ([#665](https://github.com/algolia/shipjs/issues/665)) ([901fcd8](https://github.com/algolia/shipjs/commit/901fcd8120acd6f6e59dabb4cdb718fc50fe75cf))
+
+
+
 # [0.15.0](https://github.com/algolia/shipjs/compare/v0.14.2...v0.15.0) (2020-02-03)
 
 
@@ -277,7 +510,9 @@ Please refer to [the guide](https://community.algolia.com/shipjs/guide/getting-s
 - upload assets to GitHub release ([#334](https://github.com/algolia/shipjs/issues/334)) ([fcf2807](https://github.com/algolia/shipjs/commit/fcf2807))
   - At `ship.config.js`, You can configure `releaeses.assetsToUpload`. More details in configuration will come soon.
 
-### BREAKING CHANGES
+### BREAKING CHANGE
+
+<img src="./assets/breaking-change.png" alt="BREAKING CHANGE" title="BREAKING CHANGE" width=250 height=60 />
 
 It's a breaking change but haven't bumped the major version since it's still in beta.