Skip to content

Commit c698e23

Browse files
authored
chore: activate the release please bot and add release documentation (#55)
1 parent 5fabe81 commit c698e23

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

.github/release-please.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
handleGHRelease: true
2+
manifest: true

docs/releases.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Release Process
2+
3+
This document outlines the release process for this project, which is automated using a combination of [Release Please](https://github.com/googleapis/release-please) and GitHub Actions.
4+
5+
## Overview
6+
7+
The release process is triggered by merging a "Release PR" to the `main` branch. This PR is automatically created and updated by the [Release Please bot](https://github.com/apps/release-please).
8+
9+
## Release Please Workflow
10+
11+
1. **Conventional Commits:** This repository follows the [Conventional Commits](https://www.conventionalcommits.org/) specification. The commit messages are used by Release Please to determine the next version number and to generate a changelog.
12+
13+
2. **Release PR:** When new commits that should trigger a release (e.g., `feat:`, `fix:`) are pushed to the `main` branch, the Release Please bot will create or update a pull request. This "Release PR" includes:
14+
* A version bump in the `gemini-extension.json` and other relevant files.
15+
* An updated `CHANGELOG.md` with the latest changes.
16+
17+
3. **Triggering a Release:** To create a new release, a repository maintainer simply needs to merge the Release PR.
18+
* The [Release Please bot](https://github.com/apps/release-please) creates a new GitHub Release with the version number from the merged PR.
19+
* The changelog from the Release PR is used as the release notes.
20+
21+
## GitHub Actions Workflow
22+
23+
The `package-and-upload-assets.yml` workflow then packages the extension and uploads it as a release asset to the GitHub Release.

0 commit comments

Comments
 (0)