An open API service indexing awesome lists of open source software.

https://github.com/azu/lerna-monorepo-github-actions-release

Lerna + monorepo +GitHub Actions Release Flow
https://github.com/azu/lerna-monorepo-github-actions-release

Last synced: 6 months ago
JSON representation

Lerna + monorepo +GitHub Actions Release Flow

Awesome Lists containing this project

README

          

**Edit**: I moved to following workflow.

- [azu/monorepo-github-releases: monorepo release flow: lerna + GitHub Release's Automatically generated release notes](https://github.com/azu/monorepo-github-releases)

# Lerna + monorepo +GitHub Actions Release Flow

This repository is an example of monorepo release flow.

## Purposes

- User can control packages versions
- Publish tag and packages from CI
- Does not support independent mode

## Roles and Works

1. [Person] Develop and Submit Release Pull Request
2. [Team] Review Release Pull Request
3. [CI] Publish

## Release Flow

0. [Local] Checkout release branch: `git checkout release/`
1. [Local] Run `yarn run versionup`
- Update CHANGELOG.md and `package.json`'s `version`, and `lerna.json`'s `version`
- It does not git tag
2. [Local] Submit to Release Pull Request
3. [GitHub] Review Release Pull Request
4. [GitHub] Write Release Note into the Release Pull Request's body
4. [GitHub] Merge Release Pull Request
5. [CI] Create git tag && Create GitHub Release && publish to npm(GitHub Package Registry)
- :memo: The GitHub Release's body is copied from Release Pull Request's body

## Changelog

See [Releases page](https://github.com/azu/lerna-monorepo-github-actions-release/releases).

## Running tests

Install devDependencies and Run `npm test`:

npm test

## Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, [please create an issue](https://github.com/azu/lerna-monorepo-github-actions-release/issues).

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)

## License

MIT © azu