https://github.com/robindaugherty/releasedrafter-example

A project that we use to demonstrate the release-drafter GitHub Action.
https://github.com/robindaugherty/releasedrafter-example

release-automation

Last synced: 6 days ago
JSON representation

A project that we use to demonstrate the release-drafter GitHub Action.

• Host: GitHub
• URL: https://github.com/robindaugherty/releasedrafter-example
• Owner: RobinDaugherty
• Created: 2021-08-30T20:39:33.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-08T18:36:04.000Z (over 3 years ago)
• Last Synced: 2024-11-24T04:24:20.328Z (about 2 months ago)
• Topics: release-automation
• Homepage: https://github.com/marketplace/actions/release-drafter
• Size: 27.3 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Release Drafter Example

A project that we use to demonstrate the [release-drafter](https://github.com/marketplace/actions/release-drafter) GitHub Action.

This works in two phases.

## Pull Request Auto Labeler

When a pull request opens, tags are added to the PR based on the branch name/title/description.

As configured in this repo, the following labels are automatically added:

- `feature` if the branch name starts with "feature"

- `patch fix` if the branch name starts with "fix"

- `chore` if the branch name starts with "chore"

- `breaking change` if the *pull request title* contains the word "breaking"

## Releaser

When the main branch gets a new commit (including a PR merge) the next draft release is built based on the unreleased commits.

When release notes are being drafted, semantic versioning is followed: _major_._minor_._patch_ with the tag having the prefix "v".

_For this to give the next draft release a name, you must already have an existing release, since numbering will be continued from there._

By default a minor release is drafted.

But if _all_ PRs in the release are tagged `patch fix` or `chore`, a patch release is drafted.

But if _any_ PR in the release is tagged `breaking change`, a major release is drafted.

## Testing this repository

1. Add something to the bottom of `test.md`.

2. Commit it in a new branch.

3. Open a PR for the new branch.

4. Merge the PR.

5. Verify that the PR was added to the latest unpublished release.