Skip to content

Commit cc46a40

Browse files
authored
chore: configure releases as draft to enable pre-release testing (#117)
1 parent 8be8be6 commit cc46a40

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

docs/releases.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,23 @@ The release process is triggered by merging a "Release PR" to the `main` branch.
1414
* A version bump in the `gemini-extension.json` and other relevant files.
1515
* An updated `CHANGELOG.md` with the latest changes.
1616

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.
17+
3. **Triggering a Release:** When a maintainer merges the Release PR, the release process is triggered.
18+
* The Release Please bot creates a new **draft** GitHub Release with the version number from the merged PR.
1919
* The changelog from the Release PR is used as the release notes.
2020

2121
## GitHub Actions Workflow
2222

2323
The `package-and-upload-assets.yml` workflow then packages the extension and uploads it as a release asset to the GitHub Release.
24+
25+
## Testing the Release
26+
27+
Before publishing the release publicly, you can test it by marking it as a pre-release.
28+
29+
1. Navigate to the draft release on the GitHub Releases page.
30+
2. Click "Edit" on the draft release.
31+
3. Check the "This is a pre-release" box and click "Publish release".
32+
4. Install the pre-release version using the Gemini CLI:
33+
```bash
34+
gemini extensions install https://github.com/gemini-cli-extensions/security --pre-release
35+
```
36+
5. After testing is complete, you can edit the pre-release and uncheck the "This is a pre-release" box to make it a public release.

release-please-config.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"release-type": "simple",
44
"packages": {
55
".": {
6+
"draft": true,
67
"extra-files": [
78
{
89
"type": "json",

0 commit comments

Comments
 (0)