36 lines
1.3 KiB
Markdown
36 lines
1.3 KiB
Markdown
(DEVELOP) SoftMaskForUGUI
|
|
===
|
|
|
|
**NOTE: This branch is for development purposes only.**
|
|
**To use a released package, see [Releases page](https://github.com/mob-sakai/SoftMaskForUGUI/releases) or [default branch](https://github.com/mob-sakai/SoftMaskForUGUI).**
|
|
|
|
|
|
## How to develop this package
|
|
|
|
1. Fork the repository and create your branch from `develop`
|
|
3. Open the project and click `Open Sesame > Develop Mode`
|
|
4. Develop the package
|
|
5. Test the package with test runnner (`Window > Generals > Test Runner`)
|
|
6. Commit with a message based on [Angular Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153)
|
|
7. Create a pull request on GitHub
|
|
|
|
For details, see [CONTRIBUTING](https://github.com/mob-sakai/SoftMaskForUGUI/blob/main/CONTRIBUTING.md) and [CODE_OF_CONDUCT](https://github.com/mob-sakai/SoftMaskForUGUI/blob/main/CODE_OF_CONDUCT.md).
|
|
|
|
|
|
## How to release this package
|
|
|
|
When you push to `preview`, `master` or `v1.x` branch, this package is automatically released by GitHub Action.
|
|
|
|
* Update version in `package.json`
|
|
* Update CHANGELOG.md
|
|
* Commit documents and push
|
|
* Update and tag upm branch
|
|
* Release on GitHub
|
|
* ~~Publish npm registory~~
|
|
|
|
Alternatively, you can release it manually with the following command:
|
|
|
|
```bash
|
|
$ npm run release -- --no-ci
|
|
```
|