Skip to content

Commit

Permalink
Merge pull request #408 from iCHEF/port/6.0.0
Browse files Browse the repository at this point in the history
Backport/6.0.0
  • Loading branch information
kyoyadmoon authored Jun 27, 2023
2 parents 981ec5a + 9319314 commit b9d0b0e
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 33 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# [6.0.0](https://github.com/iCHEF/gypcrete/compare/v5.3.0...v6.0.0) (2023-06-27)


### Features

* replace create-react-context with the native React Context API ([39b825c](https://github.com/iCHEF/gypcrete/commit/39b825ccf92f6ad3073841285931b516fffa3dc8))
* upgrade react-textarea-autosize ([58ac7b7](https://github.com/iCHEF/gypcrete/commit/58ac7b762606bc72ff71a2cf03394a11821e35fe))



# [5.3.0](https://github.com/iCHEF/gypcrete/compare/v5.2.0...v5.3.0) (2023-03-10)


Expand Down
33 changes: 11 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,28 +66,17 @@ Gypcrete does not publish develop builds to the `dist` branch anymore. It now pu
* When pushed to `develop` branch --> publish a canary build
* When pushed to `master` branch --> publish a relase build

### Releasing

We're relying on Lerna for versioning and publishing. When you create a Release on Github, it will trigger task on Travis CI to publish with Lerna. It also converts the lightweight tag created by Github Release to an annotated tag for Lerna to calculate versions.

When releasing a new version for Gypcrete, follow the steps:

1. Create a release branch `release/x.y.z`
2. *(Optional)* Release beta builds with `yarn release:pre` locally to specify version.
3. Bump version for `package.json` and `CHANGELOG`.
4. Bump children packages version with script:
```sh
yarn bumpversion
```
This will run `lerna version`, which updates all `package.json` files in `packages/`.

5. Commit above changes, then create a pull request for this release branch.
6. *[Important]* Create a new Release on Github in format of `v3.4.5` once it's merged into `master`.
Please be sure to prefix the tag name with `v` as Lerna uses them to calculate changes.

7. Backport changes from `master` back to `develop` by creating a `backport/x.y.y` branch and create a pull request for that.

At the time Github Release is created, it should trigger `yarn release` on Travis CI and publishes packages to npm.
## Release

1. 從 develop 開出新的 release branch,release branch 的格式必須符合 `release/x.y.z`,例如 `release/1.2.3``x.y.z` 的部分為欲發佈的版號,必須符合 semantic versioning。
2. 以這支新的 release branch 開出新的 PR,base branch 設為 `master`
3. 當 PR 被 merge 時,會觸發 github action 的 [Release workflow](https://github.com/iCHEF/fe-modules/blob/master/.github/workflows/release.yml),此 workflow 會在 master branch 做下列動作:
- 更新 package.json 的 version 並 commit
- 執行 `yarn changelog` 更新 CHANGELOG.md
- 打 git tag 並將 tag push 上 github
- 發佈新版本到 npm
- 開出 backport 到 develop branch 的 PR
4. merge backport PR。至此完成 release 流程。

## LICENSE
This project is licensed under the terms of the [Apache License 2.0](https://github.com/ichef/gypcrete/blob/master/LICENSE)
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"packages": [
"packages/*"
],
"version": "5.3.0",
"version": "6.0.0",
"npmClient": "yarn",
"command": {
"version": {
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ichef/gypcrete-build",
"version": "5.3.0",
"version": "6.0.0",
"description": "iCHEF web components library, built with React.",
"private": true,
"homepage": "https://ichef.github.io/gypcrete",
Expand Down
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ichef/gypcrete",
"version": "5.2.0",
"version": "6.0.0",
"description": "iCHEF web components library, built with React.",
"homepage": "https://ichef.github.io/gypcrete",
"repository": "https://github.com/iCHEF/gypcrete/tree/master/packages/core",
Expand Down
4 changes: 2 additions & 2 deletions packages/form/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ichef/gypcrete-form",
"version": "5.2.0",
"version": "6.0.0",
"description": "Form components built on Gypcrete",
"homepage": "https://ichef.github.io/gypcrete",
"repository": "https://github.com/iCHEF/gypcrete/tree/master/packages/form",
Expand Down Expand Up @@ -35,7 +35,7 @@
"react": "^17.0.2"
},
"dependencies": {
"@ichef/gypcrete": "^5.2.0",
"@ichef/gypcrete": "^6.0.0",
"classnames": "^2.2.5",
"immutable": "^3.8.2",
"keycode": "^2.1.9",
Expand Down
4 changes: 2 additions & 2 deletions packages/imageeditor/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ichef/gypcrete-imageeditor",
"version": "5.3.0",
"version": "6.0.0",
"description": "Image cropper built with Gypcrete",
"homepage": "https://ichef.github.io/gypcrete",
"repository": "https://github.com/iCHEF/gypcrete/tree/master/packages/imageeditor",
Expand Down Expand Up @@ -35,7 +35,7 @@
"react": "^17.0.2"
},
"dependencies": {
"@ichef/gypcrete": "^5.2.0",
"@ichef/gypcrete": "^6.0.0",
"classnames": "^2.2.5",
"react-avatar-editor": "^11.0.2",
"warning": "^4.0.3"
Expand Down
8 changes: 4 additions & 4 deletions packages/storybook/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ichef/gypcrete-storybook",
"version": "5.3.0",
"version": "6.0.0",
"description": "React Storybook for Gypcrete",
"private": true,
"repository": "iCHEF/gypcrete",
Expand All @@ -20,9 +20,9 @@
"ghpages": "npm run clean && npm run build:storybook"
},
"dependencies": {
"@ichef/gypcrete": "^5.2.0",
"@ichef/gypcrete-form": "^5.2.0",
"@ichef/gypcrete-imageeditor": "^5.3.0",
"@ichef/gypcrete": "^6.0.0",
"@ichef/gypcrete-form": "^6.0.0",
"@ichef/gypcrete-imageeditor": "^6.0.0",
"@storybook/addon-actions": "^5.3.2",
"@storybook/addon-docs": "^5.3.2",
"@storybook/addon-info": "^5.3.2",
Expand Down

0 comments on commit b9d0b0e

Please sign in to comment.