Prompt file imported from improving/improving-pdf (.windsurf/workflows/release.md). Copyright stays with the author.

Release Workflow

Name: release
Author: improving

This workflow cuts a new release of the improving-pdf-tool package. It bumps the version, commits, tags, pushes to GitHub, and creates a GitHub release.

Prerequisites

Before starting, verify all of the following:

Confirm you are on the main branch: // turbo

git branch --show-current

If not on main, stop and tell the user.

Confirm the working tree is clean: // turbo

git status --porcelain

If there is output (uncommitted changes), stop and tell the user to commit or stash first.

Confirm gh CLI is available: // turbo

gh --version

If not installed, stop and tell the user to install GitHub CLI (gh) and authenticate with gh auth login.

Steps

Ask the user what type of version bump to perform: major, minor, or patch. If the user already specified the bump type when invoking this workflow, use that.
Read the current version from src/improving_pdf_tool/__init__.py. The version is stored as __version__ = "X.Y.Z". Parse X, Y, Z as integers.
Compute the new version:
- patch: increment Z (e.g., 1.2.3 → 1.2.4)
- minor: increment Y, reset Z to 0 (e.g., 1.2.3 → 1.3.0)
- major: increment X, reset Y and Z to 0 (e.g., 1.2.3 → 2.0.0)
Update the version in both files:
- src/improving_pdf_tool/__init__.py: update __version__ = "X.Y.Z"
- pyproject.toml: update version = "X.Y.Z"
Stage the changes:

git add -A

Commit with the release message:

git commit -m "release: vX.Y.Z"

Replace X.Y.Z with the actual new version.

Create an annotated git tag:

git tag -a vX.Y.Z -m "Release vX.Y.Z"

Push the commit and tag to origin:

git push origin main --tags

Create a GitHub release with auto-generated notes:

gh release create vX.Y.Z --title "vX.Y.Z" --generate-notes

Print a summary for the user:

Release vX.Y.Z complete!

Install this version:
  pip install git+https://github.com/improving/improving-pdf.git@vX.Y.Z

Install latest:
  pip install git+https://github.com/improving/improving-pdf.git

Check if skill.md exists and contains a pinned version reference (e.g., @v). If so, remind the user to update the pinned version in skill.md to the new version.

# Release Workflow This workflow cuts a new release of the `improving-pdf-tool` package. It bumps the version, commits, tags, pushes to GitHub, and creates a GitHub release. ## Prerequisites Before starting, verify all of the following: 1. Confirm you are on the `main` branch: // turbo ``` git branch --show-current ``` If not on `main`, stop and tell the user. 2. Confirm the working tree is clean: // turbo ``` git status --porcelain ``` If there is output (uncommitted changes), stop and tell the user to commit or stash first. 3. Confirm `gh` CLI is available: // turbo ``` gh --version ``` If not installed, stop and tell the user to install GitHub CLI (`gh`) and authenticate with `gh auth login`. ## Steps 4. Ask the user what type of version bump to perform: `major`, `minor`, or `patch`. If the user already specified the bump type when invoking this workflow, use that. 5. Read the current version from `src/improving_pdf_tool/__init__.py`. The version is stored as `__version__ = "X.Y.Z"`. Parse X, Y, Z as integers. 6. Compute the new version: - `patch`: increment Z (e.g., 1.2.3 → 1.2.4) - `minor`: increment Y, reset Z to 0 (e.g., 1.2.3 → 1.3.0) - `major`: increment X, reset Y and Z to 0 (e.g., 1.2.3 → 2.0.0) 7. Update the version in **both** files: - `src/improving_pdf_tool/__init__.py`: update `__version__ = "X.Y.Z"` - `pyproject.toml`: update `version = "X.Y.Z"` 8. Stage the changes: ``` git add -A ``` 9. Commit with the release message: ``` git commit -m "release: vX.Y.Z" ``` Replace X.Y.Z with the actual new version. 10. Create an annotated git tag: ``` git tag -a vX.Y.Z -m "Release vX.Y.Z" ``` 11. Push the commit and tag to origin: ``` git push origin main --tags ``` 12. Create a GitHub release with auto-generated notes: ``` gh release create vX.Y.Z --title "vX.Y.Z" --generate-notes ``` 13. Print a summary for the user: ``` Release vX.Y.Z complete! Install this version: pip install git+https://github.com/improving/improving-pdf.git@vX.Y.Z Install latest: pip install git+https://github.com/improving/improving-pdf.git ``` 14. Check if `skill.md` exists and contains a pinned version reference (e.g., `@v`). If so, remind the user to update the pinned version in `skill.md` to the new version.

{ "prompt": "# Release Workflow\n\nThis workflow cuts a new release of the `improving-pdf-tool` package. It bumps the version, commits, tags, pushes to GitHub, and creates a GitHub release.\n\n## Prerequisites\n\nBefore starting, verify all of the following:\n\n1. Confirm you are on the `main` branch:\n// turbo\n```\ngit branch --show-current\n```\nIf not on `main`, stop and tell the user.\n\n2. Confirm the working tree is clean:\n// turbo\n```\ngit status --porcelain\n```\nIf there is output (uncommitted changes), stop and tell the user to commit or stash first.\n\n3. Confirm `gh` CLI is available:\n// turbo\n```\ngh --version\n```\nIf not installed, stop and tell the user to install GitHub CLI (`gh`) and authenticate with `gh auth login`.\n\n## Steps\n\n4. Ask the user what type of version bump to perform: `major`, `minor`, or `patch`. If the user already specified the bump type when invoking this workflow, use that.\n\n5. Read the current version from `src/improving_pdf_tool/__init__.py`. The version is stored as `__version__ = \"X.Y.Z\"`. Parse X, Y, Z as integers.\n\n6. Compute the new version:\n - `patch`: increment Z (e.g., 1.2.3 → 1.2.4)\n - `minor`: increment Y, reset Z to 0 (e.g., 1.2.3 → 1.3.0)\n - `major`: increment X, reset Y and Z to 0 (e.g., 1.2.3 → 2.0.0)\n\n7. Update the version in **both** files:\n - `src/improving_pdf_tool/__init__.py`: update `__version__ = \"X.Y.Z\"`\n - `pyproject.toml`: update `version = \"X.Y.Z\"`\n\n8. Stage the changes:\n```\ngit add -A\n```\n\n9. Commit with the release message:\n```\ngit commit -m \"release: vX.Y.Z\"\n```\nReplace X.Y.Z with the actual new version.\n\n10. Create an annotated git tag:\n```\ngit tag -a vX.Y.Z -m \"Release vX.Y.Z\"\n```\n\n11. Push the commit and tag to origin:\n```\ngit push origin main --tags\n```\n\n12. Create a GitHub release with auto-generated notes:\n```\ngh release create vX.Y.Z --title \"vX.Y.Z\" --generate-notes\n```\n\n13. Print a summary for the user:\n```\nRelease vX.Y.Z complete!\n\nInstall this version:\n pip install git+https://github.com/improving/improving-pdf.git@vX.Y.Z\n\nInstall latest:\n pip install git+https://github.com/improving/improving-pdf.git\n```\n\n14. Check if `skill.md` exists and contains a pinned version reference (e.g., `@v`). If so, remind the user to update the pinned version in `skill.md` to the new version.", "variables": [], "notes": "Cut a new versioned release of improving-pdf-tool (bump version, tag, push, GitHub release)", "metadata": { "source": { "provider": "github-windsurf-workflows", "repository": "https://github.com/improving/improving-pdf", "path": ".windsurf/workflows/release.md", "ref": "2e3b779df7dfad6376361639d4f865b0ea0e1d6a", "url": "https://github.com/improving/improving-pdf/blob/2e3b779df7dfad6376361639d4f865b0ea0e1d6a/.windsurf/workflows/release.md", "key": "improving/improving-pdf/.windsurf/workflows/release.md" } } }

release

About

Release Workflow

Prerequisites

Steps

Use it

Manifest

Reviews