From 5cb249008b9526071b10ecd3d302172df3a3f8bc Mon Sep 17 00:00:00 2001 From: capachino Date: Wed, 19 Nov 2025 18:24:12 -0800 Subject: [PATCH] chore: configure releases as draft to enable pre-release testing --- docs/releases.md | 17 +++++++++++++++-- release-please-config.json | 1 + 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/releases.md b/docs/releases.md index 3c196ec..c816772 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -14,10 +14,23 @@ The release process is triggered by merging a "Release PR" to the `main` branch. * A version bump in the `gemini-extension.json` and other relevant files. * An updated `CHANGELOG.md` with the latest changes. -3. **Triggering a Release:** To create a new release, a repository maintainer simply needs to merge the Release PR. - * The [Release Please bot](https://github.com/apps/release-please) creates a new GitHub Release with the version number from the merged PR. +3. **Triggering a Release:** When a maintainer merges the Release PR, the release process is triggered. + * The Release Please bot creates a new **draft** GitHub Release with the version number from the merged PR. * The changelog from the Release PR is used as the release notes. ## GitHub Actions Workflow The `package-and-upload-assets.yml` workflow then packages the extension and uploads it as a release asset to the GitHub Release. + +## Testing the Release + +Before publishing the release publicly, you can test it by marking it as a pre-release. + +1. Navigate to the draft release on the GitHub Releases page. +2. Click "Edit" on the draft release. +3. Check the "This is a pre-release" box and click "Publish release". +4. Install the pre-release version using the Gemini CLI: + ```bash + gemini extensions install https://github.com/gemini-cli-extensions/security --pre-release + ``` +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. diff --git a/release-please-config.json b/release-please-config.json index a006f81..366e1d0 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -3,6 +3,7 @@ "release-type": "simple", "packages": { ".": { + "draft": true, "extra-files": [ { "type": "json",