github.com/mistwind/reviewdog@v0.0.0-20230322024206-9cfa11856d58/.github/CONTRIBUTING.md (about)

     1  # Contributing
     2  
     3  TBD for other type of contribution.
     4  
     5  ## Release Pull Request (Release Process)
     6  You can create a Pull Request to release a new version.
     7  
     8  1. Update [CHANGELOG.md](../CHANGELOG.md). Copy unreleased section and create a new version section.
     9  2. Create a Pull Request.
    10  3. Attach a label [`bump:patch`, `bump:minor`, or `bump:major`]. reviewdog uses [haya14busa/action-bumpr](https://github.com/haya14busa/action-bumpr).
    11  4. [The release workflow](./workflows/release.yml) automatically tag a
    12     new version depending on the label and create a new release on merging the
    13     Pull Request.
    14  5. Check the release workflow and verify the release. [![release](https://github.com/mistwind/reviewdog/workflows/release/badge.svg)](https://github.com/mistwind/reviewdog/actions?query=workflow%3Arelease)
    15  
    16  ### Hot Fix Release
    17  
    18  If you find a severe issue and want to release a fix ASAP without unreleased features,
    19  you may want to follow the hot-fix release process instead of the usual release flow.
    20  
    21  It's mostly similar to the usual release flow, but you need to change the target branch of release pull request.
    22  
    23  1. Create a fix and merge it into master.
    24  2. Create a release branch (`release-v{major}.{minor}`) based on the latest semver release `v{major}.{minor}.{patch}` if there is no exisisting release branch.
    25    - You need write permission to reviewdog repository to push the release branch.
    26  3. Create **another release request branch** (any name is fine) and update [CHANGELOG.md](../CHANGELOG.md).
    27  4. Create a pull request from the release request branch to **the release branch** (`release-v{major}.{minor}`) instead of master.
    28  5. Attach `bump:patch` label.
    29  6. [The release workflow](./workflows/release.yml) automatically tag a
    30     new hot-fix version and create a new release on merging the Pull Request.
    31  7. Check the release workflow and verify the release. [![release](https://github.com/mistwind/reviewdog/workflows/release/badge.svg)](https://github.com/mistwind/reviewdog/actions?query=workflow%3Arelease)
    32  8. Merge the release branch into master to include the CHANGELOG.md update.