Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(inputs)!: add list of labels #108

Merged
merged 7 commits into from
Jan 28, 2024
Merged

feat(inputs)!: add list of labels #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1701f49
feat(inputs): add list of labels
benjamin-guibert Jan 28, 2024
87704f6
build(main): update build
benjamin-guibert Jan 28, 2024
7152cdc
feat(inputs): update default label values
benjamin-guibert Jan 28, 2024
4bc3912
docs(readme): update labels input
benjamin-guibert Jan 28, 2024
27d9933
docs(readme): fix typo
benjamin-guibert Jan 28, 2024
3d7cbe9
build(main): update build
benjamin-guibert Jan 28, 2024
c593a6a
docs(readme): update example
benjamin-guibert Jan 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 36 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,17 +70,16 @@ flowchart LR

It should be used if:

- Commits are systematically pushed to the main/production branch **through pull requests**;
- Labels are used in PRs to classify the type (patch, minor, major);
- Commits (that matter) are systematically pushed to the main/production branch **through pull requests**;
- Labels are used in PRs to classify the level of update (patch, minor, major);
- The release commit is just about updating the `package.json` file.

### When it should not be used

It should not be used if:

- Commits are **pushed directly** to the main/production branch;
- The release commit must include more than updating the `package.json` file,
such as a changelog (the changelog is generated in the PR body and GitHub release).
- The version update is not managed in the `package.json` file.

## Usage

Expand Down Expand Up @@ -109,22 +108,25 @@ on:
- beta
- rc

concurrency:
group: ${{ github.workflow }}
cancel-in-progress: true

permissions:
contents: write
pull-requests: write

env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:
release:
name: Release
runs-on: ubuntu-latest
outputs:
is-released: ${{ steps.action.outputs.is-released }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Execute action
id: action
uses: cyberspace7/release-action@v0.4.0
Expand All @@ -134,7 +136,7 @@ jobs:
publish: # Execute another job when a release has been made
name: Publish
needs: release
if: ${{ needs.release.outputs.is-released == 'true' }}
if: needs.release.outputs.is-released == 'true'
uses: ./.github/workflows/publish.yml
with:
pre-release: ${{ inputs.pre-release != '' }}
Expand All @@ -147,21 +149,20 @@ jobs:
> another job to deploy the fresh release (i.e. create a package, deploy a Docker container,
> etc.), as well as `pre-release`.

When opening a PR on the main/production branch, use one (or more) of the following labels in
When opening a PR on the production branch, use one (or more) of the following labels in
order to bump the version to the right level. Labels and branches can be customised through [inputs](#inputs).

- `type: fix`: Bump the **patch** part of the version.
- `type: feature`: Bump the **minor** part of the version.
- `breaking`: Bump the **major** part of the version, or minor if current version is under `1.0`.
- `patch`: Bump the **patch** part of the version.
- `minor`: Bump the **minor** part of the version.
- `major`: Bump the **major** part of the version, or minor if current version is under `1.0`.
- `changelog-ignore`: Dont bump whatever other labels are. It should be excluded from
the release notes generation (see bellow).

That's it, when merged, you should find an open release PR. You just have to merge it when you wish to release, voilà!

Changes are found comparing GitHub
[generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes),
therefore it's advised to have a `.github/release.yml` file excluding release PR labels and
the ignore label so that they don't appear as changes:
therefore it's advised to define a `.github/release.yml` file excluding release PR labels and ignore labels so that they don't appear in the changelog:

```yaml
changelog:
Expand Down Expand Up @@ -191,18 +192,26 @@ permissions:

### Inputs

| Name | Description | Default Value |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| `release-as` | Force a specific version. | |
| `pre-release` | Name of the pre-release version (`alpha`, `beta`, `rc`...). If not empty, will trigger a pre-release. | |
| `label-ignore` | Label for pull requests to be ignored for the release bump. It should be added to changelog excluded labels (see #usage). | `changelog-ignore` |
| `label-patch` | Label for pull requests to bump a patch version. | `type: fix` |
| `label-minor` | Label for pull requests to bump a minor version. | `type: feature` |
| `label-major` | Label for pull requests to bump a major version. | `breaking` |
| `label-ready` | Label automatically used by Release Action for release PRs. | `release: ready` |
| `label-done` | Label automatically used by Release Action for release PRs that have been processed (current version released). | `release: done` |
| `branch-production` | Branch used for production, the base for all PRs going to production. | `main` |
| `branch-release` | Branch used for release PRs. | `releases/next` |
| Name | Description | Default Value |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| `release-as` | Force a specific version. | |
| `pre-release` | Name of the pre-release version (`alpha`, `beta`, `rc`...). If not empty, will trigger a pre-release. | |
| `labels-ignore`\* | Labels for pull requests to be ignored for the release bump. It should be added to changelog excluded labels (see #usage). | `changelog-ignore` |
| `labels-patch`\* | Labels for pull requests to bump a patch version. | `patch`, `fix` |
| `labels-minor`\* | Labels for pull requests to bump a minor version. | `minor`, `feature` |
| `labels-major`\* | Labels for pull requests to bump a major version. | `major`, `breaking` |
| `label-ready` | Label automatically used by Release Action for release PRs. | `release: ready` |
| `label-done` | Label automatically used by Release Action for release PRs that have been processed (current version released). | `release: done` |
| `branch-production` | Branch used for production, the base for all PRs going to production. | `main` |
| `branch-release` | Branch used for release PRs. | `releases/next` |

\*Multiple labels can be defined using a multiline block such as follow:

```yaml
labels-patch: |-
patch
fix
```

### Outputs

Expand Down
28 changes: 14 additions & 14 deletions __tests__/libs/inputs.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,10 @@ describe("parseInputs()", () => {
const result = parseInputs();

expect(result.releaseLabels).toEqual({
ignore: "changelog-ignore",
patch: "type: fix",
minor: "type: feature",
major: "breaking",
ignore: ["changelog-ignore"],
patch: ["patch", "fix"],
minor: ["minor", "feature"],
major: ["major", "breaking"],
ready: "release: ready",
done: "release: done",
});
Expand All @@ -115,24 +115,24 @@ describe("parseInputs()", () => {
it("should return values when defined", () => {
mockInputs({
releaseLabels: {
ignore: "ignore-label",
patch: "patch-label",
minor: "minor-label",
major: "major-label",
ignore: "\r\n",
patch: "patch-label-1 \r\npatch-label-2",
minor: "\r\nminor-label",
major: "major-label\r\n",
ready: "ready-label",
done: "done-label",
done: " ",
},
});

const result = parseInputs();

expect(result.releaseLabels).toEqual({
ignore: "ignore-label",
patch: "patch-label",
minor: "minor-label",
major: "major-label",
ignore: ["changelog-ignore"],
patch: ["patch-label-1", "patch-label-2"],
minor: ["minor-label"],
major: ["major-label"],
ready: "ready-label",
done: "done-label",
done: "release: done",
});
});
});
Expand Down
14 changes: 7 additions & 7 deletions __tests__/libs/version.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,36 +12,36 @@ describe("getVersionBumpLevel()", () => {
],
[
{
labels: [{ name: "type: fix" }],
labels: [{ name: "patch" }],
},
{
labels: [{ name: "label" }],
},
],
[
{
labels: [{ name: "type: fix" }],
labels: [{ name: "patch" }],
},
{
labels: [
{ name: "type: feature" },
{ name: "breaking" },
{ name: "minor" },
{ name: "major" },
{ name: "changelog-ignore" },
],
},
{
labels: [{ name: "type: feature" }],
labels: [{ name: "minor" }],
},
{
labels: [{ name: "label" }],
},
],
[
{
labels: [{ name: "type: fix" }],
labels: [{ name: "patch" }],
},
{
labels: [{ name: "type: feature" }, { name: "breaking" }],
labels: [{ name: "minor" }, { name: "major" }],
},
{
labels: [{ name: "label" }],
Expand Down
8 changes: 4 additions & 4 deletions __tests__/prepare.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ describe("main()", () => {
inputs.preRelease = null;
inputs.releaseAs = null;
inputs.releaseLabels = {
ignore: "changelog-ignore",
patch: "type: fix",
minor: "type: feature",
major: "breaking",
ignore: ["changelog-ignore"],
patch: ["type: fix", "type: performance"],
minor: ["type: feature"],
major: ["breaking"],
ready: "release: ready",
done: "release: done",
};
Expand Down
Loading
Loading