Skip to content
This repository has been archived by the owner on Feb 1, 2024. It is now read-only.

Commit

Permalink
Merge pull request #2438 from teamleadercrm/readme-update
Browse files Browse the repository at this point in the history
Updated readme with new release process
  • Loading branch information
qubis741 authored Nov 9, 2022
2 parents bb36af0 + 2528c75 commit bb10b97
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,20 +62,16 @@ $ PORT=3001 yarn start
- [component].stories.tsx file is present
- component is exported in index.ts

## How to make a release
## How we do a release

1. Pull the `next-release` branch to make sure you have all the latest code on your local machine.
2. Make a new branch, starting from `next-release` and give it the name of the next version you want to release (`release/new.version.number`).
3. Bump the version in `package.json` and commit with message `Version bump` and push.
4. Update `CHANGELOG.md`
1. Create PR with your desired changes
2. Bump the version in `package.json` and commit with message `Version bump`. [Semantic Versioning](https://docs.npmjs.com/about-semantic-versioning)
3. Update `CHANGELOG.md`

- Replace `[unreleased]` with the `[new.version.number]` and add the release `date next to it, like this`- yyyy-mm-dd`.
- Clean up the unused titles.
- Prepare for next release by adding the following content on top of the file:
- Place `## [new.version.number] - yyy-mm-dd` above last release
- Add heading that best fits your change:

```
## [unreleased]
### Added
### Changed
Expand All @@ -89,18 +85,23 @@ $ PORT=3001 yarn start
### Dependency updates
```
- Add you change in format `Component: short-description ([github-username](link-to-github-user)) in [#PR-ID](link-to-PR)`
- Commit with message `Update changelog` and push.
- EXAMPLE:
```
## [16.4.3] - 2022-10-31
### Fixed
- `Select`: Allow multiple selects being rendered at once ([@stefaandevylder](https://github.com/stefaandevylder)) in [#2422](https://github.com/teamleadercrm/ui/pull/2422)
```
5. Make a `pull request` on Github where you add the `changelog items` as the description and wait for approval.
6. Make a `draft release` on Github and fill in the following fields:
4. Once the pull request has the needed amount of approvals, merge it into the `next-release` branch.
5. Publish a `release` on Github and fill in the following fields:
- **Tag version:** `new.version.number` @ `target: next-release`
- **Release title:** `new.version.number`
- **Description:** add the `changelog items`
7. Once the pull request has the needed amount of approvals, merge it into the `next-release` branch.
8. `Publish` the earlier created `draft release` on Github.
9. In your `console`, pull the `next-release` branch.
10. `Publish` to `npm` using the `npm publish --access=public` command.
11. `Merge` the `next-release` branch into `master` and push to Github
6. In your `console`, pull the `next-release` branch.
7. `Publish` to `npm` using the `npm publish --access=public` command.
8. `Merge` the `next-release` branch into `master` and push to Github
## License
Expand Down

0 comments on commit bb10b97

Please sign in to comment.