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.

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(release): trigger release using release please bot on dev branch #1208

Merged
merged 3 commits into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 1 addition & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
name: Release Please

on:
push:
branches:
- main
workflow_dispatch:

jobs:
Expand All @@ -25,5 +22,4 @@ jobs:
release-type: node
package-name: '@boiler/boiler'
token: ${{ secrets.GITHUB_TOKEN }}
target-branch: main
branch: main
if: env.skip_release == 'false'
31 changes: 8 additions & 23 deletions docs/DEPLOYMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,10 @@ We use the [Git-Flow](https://www.atlassian.com/git/tutorials/comparing-workflow

```mermaid
gitGraph
commit id: "a"
commit id: "a"
commit id: "b"
branch develop
checkout develop
checkout develop
branch feature1
checkout feature1
commit id: "c"
Expand All @@ -47,26 +46,18 @@ We use the [Git-Flow](https://www.atlassian.com/git/tutorials/comparing-workflow
commit id: "d"
checkout develop
merge feature2
checkout main
merge develop
branch "release"
checkout release
commit id: "1.0.0" tag: "release"
checkout main
merge release
checkout develop
merge main
```

## Release Please

Release Please automates CHANGELOG generation, the creation of GitHub releases, and version bumps for your projects.
Release Please does so by parsing the git history, looking for Conventional Commit messages, and creating release PRs.

The tool runs on every update on the `main` branch and creates a release PR which needs to be manually be merged to
create the release.
The tool runs when a manual trigger is done on Release Please workflow. This generates a release PR.

The updated `main` branch then needs to be merged back, please use rebase, into the `develop` branch.
Once the release PR is merged (back into `develop`), release-please automatically creates a GitHub release based on the
merged changes.

## Conventional Commit Messages

Expand All @@ -77,16 +68,10 @@ exceed a maximum character count of 140. The scope is allowed to be one of the f

## How to deploy

One needs to create a new PR from `develop` to `main`. Once the PR is approved and merged the GitHub workflow `release`
will be started.

The `release` workflow will first run the tests and after they were successful a new release branch is created together
with a PR from the release branch into `main`.

The newly created release PR needs to be manually merged into main to finish the package creation and release
publishing.

After the release PR is merged the `develop` branch also needs to be updated by rebasing it onto the `main` branch.
Deployment is automated via the release-please workflow, which operates on the develop branch. Push changes to the
develop branch. The release-please workflow creates a release PR on develop with version bumps and changelog updates.
Review and merge the release PR back into develop. Once merged, the workflow publishes the package to the npm registry
and creates a GitHub release.

## Versioning

Expand Down
Loading