René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Promote PR bump preview to a reusable workflow in setup-cz","articleBody":"### Description\n\nFollowing the rollout of the PR bump preview pattern across three repos (#1510), the workflow is currently duplicated in three places:\n\n- `commitizen-tools/commitizen/.github/workflows/pr-bump-preview.yml`\n- `commitizen-tools/commitizen-action/.github/workflows/pr-bump-preview.yml`\n- `commitizen-tools/setup-cz/examples/pr-bump-preview.yaml` (copy-paste source for end users)\n\nThe recent security fix (same-repo guard + `persist-credentials: false`) had to be applied to all three copies independently. Future maintenance — new `actions/checkout` versions, comment-action upgrades, additional flags — will incur the same per-repo cost.\n\n### Possible Solution\n\nPromote the example into a **reusable workflow** hosted in `commitizen-tools/setup-cz`.\n\n**Files**\n\n1. New `setup-cz/.github/workflows/pr-bump-preview.yml` with `on: workflow_call` and inputs:\n   - `cz-version` (default `latest`) → forwarded to `setup-cz`\n   - `extra-requirements` (default empty) → forwarded to `setup-cz`\n   - `ref` (optional) → checkout ref override\n2. `examples/pr-bump-preview-wrapper.yaml` shrinks to a thin wrapper showing `uses: commitizen-tools/setup-cz/.github/workflows/pr-bump-preview.yml@v1`.\n\n**Consumer wrapper (~8 lines)**\n\n```yaml\non:\n  pull_request_target:\n    types: [opened, reopened, synchronize, ready_for_review]\npermissions: { contents: read, pull-requests: write }\njobs:\n  preview:\n    uses: commitizen-tools/setup-cz/.github/workflows/pr-bump-preview.yml@v1\n```\n\n**Migration**\n\nAfter this lands and a setup-cz release is cut:\n\n- This repo: replace the 80-line workflow with the 8-line wrapper.\n- `commitizen-tools/commitizen-action`: same.\n\n**Why a reusable workflow (not a composite action)?**\n\nA composite action would still need every consumer to write the `pull_request_target` trigger, the same-repo guard, the checkout, and the comment-posting step. Those are the exact bits we want to deduplicate. Reusable workflows encapsulate the whole job.\n\n**Why now wasn't the right time**\n\nDoing this in the original three PRs was rejected to avoid cross-repo merge coordination and to gather data on what inputs actually matter. Once the workflow has run on a few real PRs, we'll know whether `working-directory`, `cz-version` overrides, etc. are actually needed before committing them to a public reusable-workflow contract.\n\n### Additional context\n\nMirrors `commitizen-tools/setup-cz#20` so this work item is also tracked here for visibility alongside the original feature request.\n\nAcceptance:\n\n- [ ] Reusable workflow at `setup-cz/.github/workflows/pr-bump-preview.yml`\n- [ ] Trimmed example at `examples/pr-bump-preview-wrapper.yaml`\n- [ ] Tag a setup-cz release containing the new workflow\n- [ ] Follow-up PR here swapping the workflow for the wrapper\n- [ ] Follow-up PR in `commitizen-tools/commitizen-action` swapping the workflow for the wrapper\n\n### Related issues\n\n- Implements deduplication of work delivered in #1957 (this repo), commitizen-tools/commitizen-action#102, commitizen-tools/setup-cz#19\n- Original feature request: #1510\n- Cross-org tracker: commitizen-tools/setup-cz#20\r\n","author":{"url":"https://github.com/bearomorphism","@type":"Person","name":"bearomorphism"},"datePublished":"2026-05-09T08:59:02.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/1959/commitizen/issues/1959"}