From 934342d3852a517b0f7c7c489b21c62fdb4866d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felipe=20Say=C3=A3o=20Lobato=20Abreu?= Date: Tue, 20 Oct 2026 11:43:34 -0300 Subject: [PATCH 1/3] ci: adopt Fast Forward Changelog 0.3.0 --- .../.fast-forward-install.json | 21 +++ .agents/skills/fast-forward-changelog/LICENSE | 21 +++ .../skills/fast-forward-changelog/SKILL.md | 162 ++++++++++++++++++ .../examples/contribution.php | 45 +++++ .../references/automation.md | 89 ++++++++++ .../fast-forward-changelog/references/cli.md | 77 +++++++++ .../references/php-api.md | 40 +++++ .changelog/adopt-fast-forward-changelog.md | 6 + .changelog/ci-status-permissions.md | 6 + .changelog/contextual-artwork.md | 7 + .changelog/pin-wiki-workflow.md | 7 + .changelog/wiki-publication.md | 6 + .gitattributes | 1 + .github/workflows/changelog.yml | 63 +++---- AGENTS.md | 8 +- CHANGELOG.md | 14 -- CONTRIBUTING.md | 20 +++ 17 files changed, 536 insertions(+), 57 deletions(-) create mode 100644 .agents/skills/fast-forward-changelog/.fast-forward-install.json create mode 100644 .agents/skills/fast-forward-changelog/LICENSE create mode 100644 .agents/skills/fast-forward-changelog/SKILL.md create mode 100644 .agents/skills/fast-forward-changelog/examples/contribution.php create mode 100644 .agents/skills/fast-forward-changelog/references/automation.md create mode 100644 .agents/skills/fast-forward-changelog/references/cli.md create mode 100644 .agents/skills/fast-forward-changelog/references/php-api.md create mode 100644 .changelog/adopt-fast-forward-changelog.md create mode 100644 .changelog/ci-status-permissions.md create mode 100644 .changelog/contextual-artwork.md create mode 100644 .changelog/pin-wiki-workflow.md create mode 100644 .changelog/wiki-publication.md create mode 100644 CONTRIBUTING.md diff --git a/.agents/skills/fast-forward-changelog/.fast-forward-install.json b/.agents/skills/fast-forward-changelog/.fast-forward-install.json new file mode 100644 index 0000000..fdfb45a --- /dev/null +++ b/.agents/skills/fast-forward-changelog/.fast-forward-install.json @@ -0,0 +1,21 @@ +{ + "schema": 1, + "owner": "fast-forward/changelog", + "name": "fast-forward-changelog", + "scope": "project", + "target": ".agents/skills/fast-forward-changelog", + "source": { + "package": "fast-forward/changelog", + "version": "v0.3.0", + "reference": "85474de5a16bb08f83c9f30e0ed72f331a210f07" + }, + "files": { + "LICENSE": "58bd7c00603e499c575d53a97b8b8c1d1398f584ea5f9f77d369780efb2066ab", + "SKILL.md": "a71cfdffae34b69e555955b6b82be858bf65e4406f954d566b651cda0f0cd952", + "examples/contribution.php": "46f2b30277b4f880a8fc4f5d503d2a4fd13c6802a929159b1895f55f9a97dd2e", + "references/automation.md": "0cb96ff6d62f44c19f514fcbb42b88fbe5f7382bcfed87c533c8ac6fd3bc95bb", + "references/cli.md": "787f33efcbc72d40ce5b55507f6f0a59b686bffe4d7edfcf4242c427d7db023e", + "references/php-api.md": "32b67728f3c4ba5870a40f5ad88946dd274f84619676d4783642780a172cade8" + }, + "payload_sha256": "f1969293e2f761bfea32eb4d3e04980cf7a8f2a48313188a20d15390751eb681" +} diff --git a/.agents/skills/fast-forward-changelog/LICENSE b/.agents/skills/fast-forward-changelog/LICENSE new file mode 100644 index 0000000..f320900 --- /dev/null +++ b/.agents/skills/fast-forward-changelog/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Felipe Sayao Lobato Abreu + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/.agents/skills/fast-forward-changelog/SKILL.md b/.agents/skills/fast-forward-changelog/SKILL.md new file mode 100644 index 0000000..e43f1c0 --- /dev/null +++ b/.agents/skills/fast-forward-changelog/SKILL.md @@ -0,0 +1,162 @@ +--- +name: fast-forward-changelog +description: Adopt Fast Forward Changelog's GitHub lifecycle, write and check independent fragments, review version PRs, and perform authorized release maintenance. Discover the selected release's documentation and CLI capabilities before choosing integration details. +license: MIT +compatibility: Requires access to the application repository and the selected release's documentation. Verify that release's runner or PHP requirements before execution. Local CLI examples use CPX; PHP integration uses the application's Composer installation. GitHub credentials are needed only for authorized remote operations. +metadata: + author: php-fast-forward + source: original + repository: https://github.com/php-fast-forward/changelog + api-baseline: Verify the selected published release; commands and integration details are release-specific. +--- + +# Fast Forward Changelog + +Ordinary contributions add independent `.changelog/*.md` fragments. GitHub +automation checks each contribution, maintains PR feedback and prepares a +reviewable version PR. That PR consolidates the accepted fragments into +`CHANGELOG.md` and deletes only the consumed files. Publication follows a +separate approval for the exact result; a green check or prepared PR is not that +approval. + +## Select the real contract + +1. Read application instructions, Git status and its existing changelog setup. + Use its reviewed version for an ordinary task; do not upgrade it incidentally. + If its ref is a moving channel, resolve the current commit and corresponding + published full tag before selecting a local runtime. `v0` is not Composer `0`. +2. For new adoption or a requested update, discover the latest published stable + release in the [official repository](https://github.com/php-fast-forward/changelog/releases). + Confirm the complete release tag and its commit, exclude drafts/prereleases, + and respect any explicitly selected maintenance line. For CPX or PHP use, + confirm the same version is available on + [Packagist](https://packagist.org/packages/fast-forward/changelog). +3. Read that tag's README and relevant documentation, not `main` or an old copy + of this skill. Before adding a workflow, inspect its + `resources/workflows/changelog.yml`, companion README and the reusable workflow + they reference. Copy the release's caller, review inputs/permissions and set + its product references to that verified full tag or immutable release commit; + do not retain an obsolete embedded pin blindly. After setting the final ref, + inspect the reusable workflow at that exact ref and confirm its inputs, + permissions and runner requirements before saving the application caller. + If that release offers a project `install` command, inspect its help and prefer + its guided preview for a missing integration. Explain the release branch, + publication default and optional skill before accepting writes. + The lifecycle defaults to `publish: true`; confirm this at the selected ref. + Its automatic route publishes a version tag and GitHub Release + after the reviewed managed PR is merged; it does not merge the PR. A + validation-only trial must choose `publish: false` explicitly. Installation must + not publish anything. Preserve an existing caller, its pin and settings; + migration or upgrades need their own task scope. +4. For local CLI work, set `CHANGELOG_VERSION` to the verified exact numeric + release, without the tag's `v`. Discover commands and inspect their arguments: + + ```sh + cpx --skip-local "fast-forward/changelog:$CHANGELOG_VERSION" list --raw + cpx --skip-local "fast-forward/changelog:$CHANGELOG_VERSION" help add + cpx --skip-local "fast-forward/changelog:$CHANGELOG_VERSION" help check + ``` + + Use [CPX's official setup](https://github.com/laravel/cpx) when installation is + authorized; do not pin the executor in these commands. `--skip-local` selects + its separate tool installation. CPX may handle `--help` or `--version` itself, + so use `help ` for changelog help. An existing reviewed project binary + may be used directly instead. Confirm prerequisites from the chosen release. + +Installing this skill installs instructions, independently of the runtime. If +the selected CLI offers skill installation/check/update operations, inspect +their help and use only the supported operation and requested scope. Otherwise +follow that release's skill-installation guide; do not invent a command. + +Native installation can record the source package version, commit and payload +integrity. Compare an installed copy with the selected CLI through its documented +check operation; do not confuse that local comparison with a latest-version +lookup. Preserve NPX or other installer ownership and its lockfile rather than +trying to adopt the copy or rewrite metadata into a merely similar JSON format. + +This procedure avoids a frozen API inventory. A breaking release can still +change the lifecycle or these entrypoints: when documentation and capabilities +disagree, resolve the mismatch before writes rather than guessing compatibility. + +## Write and check a contribution + +Read the change and describe its observable effect. For example, create one +unique `.changelog/preserve-markdown-spaces.md`: + +```markdown +--- +category: fixed +type: patch +--- + +Preserves meaningful Markdown spaces when parsing fragments. +``` + +Keep existing notes and Markdown intact. Use the selected release's fragment +schema. For the established category scheme, `added`, `changed` and `deprecated` +default to `minor`, `removed` to `major`, and `fixed`/`security` to `patch`. +Persist the effective type explicitly; a justified override may express a +compatible dependency change as `changed`/`patch`. Apply the application's +versioning policy deliberately, especially during `0.x` development. + +After help confirms these arguments, the CLI can create and validate that note +from the application directory instead of writing the example manually: + +```sh +cpx --skip-local "fast-forward/changelog:$CHANGELOG_VERSION" add "Preserves meaningful Markdown spaces when parsing fragments." --category=fixed --no-interaction +cpx --skip-local "fast-forward/changelog:$CHANGELOG_VERSION" check --no-interaction +``` + +Verify that exactly one intended fragment was created and central history stayed +unchanged. Do not run both authoring routes for the same note. Fix diagnostics +and rerun the check. Before a committed PR comparison, inspect `help check`, +fetch the intended baseline under existing authority, then use its supported +comparison option, for example: + +```sh +cpx --skip-local "fast-forward/changelog:$CHANGELOG_VERSION" check --since=origin/main --no-interaction +``` + +That comparison requires committed contribution changes. A local uncommitted +fragment can pass local validation without satisfying the PR comparison. + +Optional PR/issue/author metadata must come from verified evidence. When the +origin PR is already known and supported, use `--pull-request=` or +`pull_request: ` after confirming its repository and exact head. Leave +unknown fields absent; do not invent a number or require a second fragment +commit after opening a PR. If the selected release resolves PR origins during +compilation, follow its documented policy consistently across preparation and +publication. No qualifying PR should become an invented commit or author link. + +Ordinary work preserves inherited fragments and published history. Do not add a +new `Unreleased` section. Editorial replacement, history maintenance and release +consolidation require their own task scope. + +## Verify the lifecycle + +For adoption, open a small pilot PR and inspect the exact head's required status, +sticky comment and independent application checks. Exercise a missing or +malformed note and any enabled bot route. Inspect the generated version PR: +planned version/impact, exact notes, central-history changes and only the accepted +fragment deletions. Review again after its head changes. The workflow does not +merge its own version PR. + +For the selected release, verify how committed history and ancestral tags define +the version baseline. The current lifecycle advances from the greatest stable +version in either source: tag `v1.7.0`, committed history through `1.7.1` and a +new patch produce `1.7.2`. Skipping publication does not block the next PR or +authorize retroactive publication of `1.7.1`. Preserve earlier history and review +the proposed next version; do not create missing tags as an incidental repair. + +Load only the reference needed for the task: + +- [Automation](references/automation.md): selected caller, optional settings, + credentials, maintenance lines and pilot verification. +- [CLI maintenance](references/cli.md): previews, consolidation, history, + interrupted transactions and separately authorized publication. +- [PHP integration](references/php-api.md): release-specific application + services and the bundled example, only when programmatic integration is needed. + +Retain authority already given, but do not infer commit, push, merge, installation +elsewhere or publication authority from an ordinary fragment task. Report changed +paths, executed checks and the verified version/PR/SHA relevant to the result. diff --git a/.agents/skills/fast-forward-changelog/examples/contribution.php b/.agents/skills/fast-forward-changelog/examples/contribution.php new file mode 100644 index 0000000..1fdd8de --- /dev/null +++ b/.agents/skills/fast-forward-changelog/examples/contribution.php @@ -0,0 +1,45 @@ + + * @license https://opensource.org/licenses/MIT MIT License + */ + +use FastForward\Changelog\Container\ServiceProvider\ChangelogServiceProvider; +use FastForward\Changelog\Fragment\FragmentWriterInterface; +use FastForward\Changelog\Release\Factory\ReleaseOptionsFactoryInterface; +use FastForward\Changelog\Validation\CheckServiceInterface; + +use function FastForward\Container\container; + +$autoload = $argv[1] ?? ''; +$directory = realpath($argv[2] ?? ''); +if ('' === $autoload || !is_file($autoload) || !isset($argv[2]) || false === $directory || !is_dir($directory)) { + fwrite(STDERR, "Usage: php contribution.php /consumer/vendor/autoload.php /existing/project\n"); + exit(2); +} +require $autoload; + +$container = container(ChangelogServiceProvider::class); +$options = $container->get(ReleaseOptionsFactoryInterface::class)->create([ + 'workingDirectory' => $directory, + 'source' => 'tags', +]); +$path = $container->get(FragmentWriterInterface::class)->add( + $options, + 'Preserves meaningful Markdown spaces when parsing fragments.', + category: 'fixed', + name: 'php-api-example.md', +); +$expected = "---\ncategory: fixed\ntype: patch\n---\n\nPreserves meaningful Markdown spaces when parsing fragments.\n"; +if ($expected !== file_get_contents($path)) { + throw new RuntimeException('The fragment does not match the expected application output.'); +} +if (!$container->get(CheckServiceInterface::class)->check($options)->isValid()) { + throw new RuntimeException('The pending fragment inventory is invalid.'); +} +fwrite(STDOUT, "Contribution example PASS\n"); diff --git a/.agents/skills/fast-forward-changelog/references/automation.md b/.agents/skills/fast-forward-changelog/references/automation.md new file mode 100644 index 0000000..46fe275 --- /dev/null +++ b/.agents/skills/fast-forward-changelog/references/automation.md @@ -0,0 +1,89 @@ +# GitHub lifecycle adoption + +Load when installing or changing workflows, configuring credentials or runners, +selecting maintenance lines, or diagnosing feedback. Discover the latest stable +published release for new adoption, respecting an explicitly selected release +line. For ordinary work, retain the application's reviewed implementation. + +## Use the selected release's caller + +From the verified full tag, read `README.md`, +`resources/workflows/changelog.yml`, its companion README, and the reusable +workflow referenced by that caller. Consult that tag's relevant guides, including +`docs/reusable-lifecycle.md`, `docs/github-app.md` and `docs/automation-map.md` when +present. If paths moved, follow that release's README rather than guessing. +Do not combine a caller from one version with settings copied from `main`. + +If that release lists `install`, inspect its command help and installation guide +before choosing a route. Guided setup can ask for the release branch, publication +choice, advanced overrides and optional project skill, then preview a missing +caller. It must preserve an existing caller and refuse ambiguous or competing +automation. Use read-only preview first; noninteractive application requires its +documented confirmation option. For a new caller, select the published release +through that command's supported release option; its installer can pin `uses` +to the verified commit and retain the version as a readable comment. Confirm +both identities in the preview. Preserve the selected pin of an existing caller. +The workflow and bundled skill may have separate +provenance: a workflow ref does not change the executing CLI's instructions. + +For manual setup, copy the caller into the application's `.github/workflows/`, review its events, +inputs and effective permissions, then set its product references to the selected +published complete tag or verified immutable release commit. Review older pins +embedded in the copied caller. After replacing a pin, inspect the reusable +workflow at the final selected ref and verify its actual inputs, permissions and +runner requirements before saving the application caller. +GitHub `uses` references the executable reusable +workflow under `.github/workflows`; the resource caller is a copyable asset. +Internal `repository-*` workflows belong to the library, not the consumer. + +Explain the selected reusable's publication default before installing its caller. +The lifecycle defaults to `publish: true`; verify this at the final selected ref. +The automatic route publishes the exact version tag and GitHub Release after a +reviewed managed version PR is merged. The workflow does not merge the PR. +Setup itself does not publish anything. +Choose `publish: false` explicitly when the task is a validation-only trial; +do not silently carry that override into an installation meant to publish. +Choose base and managed branches, +fragment/history paths, historical sources and PR-reference policy consistently +across enabled operations. For parallel maintenance, select a separate managed +branch per release line and verify its actual planned version; a branch's name +does not enforce a SemVer range. Use individual workflows or Docker actions only +when their release-specific contracts suit the application's orchestration. + +Full tags identify concrete releases; an immutable commit pin also keeps execution +bound to the reviewed code if an upstream tag is changed. A moving major channel +is an explicit update policy and must be documented by the selected product release; +do not assume it exists. In particular `@v0` may cross breaking `0.x` minors and +does not mean Composer `^0.1`. Changing a workflow ref is a deliberate update. + +## Credentials and acceptance + +Use the selected workflow's documented token/App route and the application's +approved secret storage. Preserve the verified automation identity and narrow +permissions. Never check out untrusted PR code in a privileged custom job. +Token-generated events may behave differently from human/App events; consult +the selected release and GitHub's current rules before promising downstream CI. + +For an explicitly validation-only pilot, use `publish: false`. Verify a valid +fragment, missing or malformed notes, the exact PR head's required status and sticky-comment recovery, +any enabled bot operation, and the generated version PR. Check the actual runner +requirements and access when changing Linux/self-hosted selection. Test custom +policy changes relevant to the application rather than assuming a default-branch +green run proves its generated head. + +The version PR must preserve exact notes and consume only its accepted fragment +set, with no technical plan files or new `Unreleased` section. Head changes need +fresh review and checks. Successful preparation does not authorize merging or +publication. Retain existing publication authority for the verified result, +using the selected release's committed evidence and recovery procedure. + +## Consolidation without publication + +Confirm the selected release's version-baseline rule. The current lifecycle uses +the greatest stable version in committed source history or ancestral stable +tags. With tag `v1.7.0` and committed history through `1.7.1`, a new patch prepares +`1.7.2` while preserving the earlier history. An explicit `publish: false` +creates neither tag nor GitHub Release, but does not block subsequent version +PRs. Enabling publication for a later merge does not publish older consolidated +versions retroactively. Do not remove history or manufacture a missing tag merely +to make another PR possible. diff --git a/.agents/skills/fast-forward-changelog/references/cli.md b/.agents/skills/fast-forward-changelog/references/cli.md new file mode 100644 index 0000000..55eea75 --- /dev/null +++ b/.agents/skills/fast-forward-changelog/references/cli.md @@ -0,0 +1,77 @@ +# CLI maintenance + +Load for release previews, history maintenance, recovery or authorized +publication. First select the real release and inspect `list --raw` and +`help ` as described in the skill. Read `docs/cli-fragments.md` and the +relevant maintenance/publication guide from that complete release tag. Verify +that its PHP and Git requirements match the environment. Do not infer arguments +or current behavior from an older installed skill. + +## Execute the selected CLI + +Run from the application's directory. `CHANGELOG_VERSION` is the verified exact +numeric product version, not a range frozen into this skill: + +```sh +cpx --skip-local "fast-forward/changelog:$CHANGELOG_VERSION" list --raw +cpx --skip-local "fast-forward/changelog:$CHANGELOG_VERSION" help status +cpx --skip-local "fast-forward/changelog:$CHANGELOG_VERSION" help version +``` + +CPX keeps tool dependencies separate from the application's Composer project; +the command still operates on application files. It is not a filesystem sandbox +or a PHP runtime. CPX's own update/help/version commands concern the executor. +An existing reviewed `vendor/bin/changelog` may run the same supported arguments +without changing the application's dependencies. + +When `list` offers instruction-management operations, inspect their help before +using install, check or update options. Use the requested project/global scope +and preserve local changes. Their existence is a discovered capability, not a +promise that every published changelog version contains them. Runtime updates, +instruction installation and host-session activation remain separate results. + +## Preview before consolidation + +For releases offering these arguments, inspect the read-only plan first: + +```sh +cpx --skip-local "fast-forward/changelog:$CHANGELOG_VERSION" status --json --source=tags --no-interaction +cpx --skip-local "fast-forward/changelog:$CHANGELOG_VERSION" version --dry-run --source=tags --no-interaction +``` + +Review the baseline/current/next version, effective impact, accepted fragment +paths, notes and affected files. Choose the relevant maintenance branch and +historical source explicitly. A branch name alone does not establish a release +range. Check command help before treating an exit code as success or failure; +check modes may use a nonzero result for drift as well as errors. + +The normal GitHub lifecycle prepares the version PR. Applying a local version +transaction requires existing consolidation authority and the same reviewed +options as the preview. Preserve exact committed input bytes, custom-template +trust requirements and any PR-resolution setting required by that release. +Verify only central history and consumed-fragment deletions are changed; no +technical plan file or new `Unreleased` section belongs in the version PR. + +If interrupted, preserve the recovery journal and remaining files. Follow that +release's recovery procedure with the same inputs. Do not edit a journal, delete +newer notes or replace history merely to force a retry. + +## Additional maintenance and publication + +Backfill, format, notes extraction and custom templates are optional operations. +Discover their actual commands and read that release's guide before using them. +Keep published descriptions, unknown dates, existing references and pending +fragments intact as required by the operation. Executable PHP templates require +explicit trust. Preview mutations and review the resulting diff. + +Publication requires separate authority for an exact approved full commit SHA. +Read that release's publication guide and command help, preview when supported, +and supply the verified target explicitly. Use the application's approved +credential mechanism. Verify the approved version, notes, consumed fragments, +tag and source commit; PR text or a moving branch is not transaction evidence. +Preparation and publication must use the same policies that affect the output. + +Do not move conflicting concrete tags or overwrite divergent published notes. +After an uncertain response, inspect remote evidence and follow the selected +release's idempotent recovery route under the existing authority. Report what +was actually published or recovered separately from successful validation. diff --git a/.agents/skills/fast-forward-changelog/references/php-api.md b/.agents/skills/fast-forward-changelog/references/php-api.md new file mode 100644 index 0000000..2dc88e4 --- /dev/null +++ b/.agents/skills/fast-forward-changelog/references/php-api.md @@ -0,0 +1,40 @@ +# Optional PHP integration + +Load only when the application needs injected services instead of the CLI or +GitHub lifecycle. CPX executes a separate tool; it does not provide an application +autoloader. Inspect the application's Composer installation with +`composer show fast-forward/changelog`, then read the PHP integration/API guide, +manifest requirements and migration notes from that exact release tag. + +Use the installed namespaces and method signatures. Keep the application's +existing command loader, container precedence and secret mechanism. Expose only +the needed domain services and inject external boundaries in application tests. +Resolving a service or writing a fragment does not authorize commits or releases. + +## Bundled contribution example + +The complete [contribution program](../examples/contribution.php) illustrates the +`0.1.0` PHP API: explicit consumer autoloader and target directory, provider +composition, fragment creation and validation. It is an optional example, not +the contract for every later release. Before using it with another version, +compare its imports/signatures with that release's documented API or use the +example shipped with the selected release. + +For a matching API, run it first in a disposable target: + +```sh +php .agents/skills/fast-forward-changelog/examples/contribution.php ./vendor/autoload.php /absolute/project +vendor/bin/changelog check --no-interaction +``` + +Success prints `Contribution example PASS`; exactly one +`.changelog/php-api-example.md` is created, with no commit or central-history +change. A repeated run must expose the filename collision rather than overwrite +the file. Missing inputs and runtime failures remain nonzero. Do not report +success after a failed write or ignore the validation report. + +Keep PR/issue/author fields absent unless verified. Service access follows the +same fragment, version-transaction and publication boundaries as the selected +release's CLI. Learn optional configuration, planner/history services and +approved-commit publication from that version's documentation when the task +requires them; do not load an API inventory for an ordinary fragment task. diff --git a/.changelog/adopt-fast-forward-changelog.md b/.changelog/adopt-fast-forward-changelog.md new file mode 100644 index 0000000..5e1b2c4 --- /dev/null +++ b/.changelog/adopt-fast-forward-changelog.md @@ -0,0 +1,6 @@ +--- +category: changed +type: patch +--- + +Adopt Fast Forward Changelog automation and its project skill for validated contribution notes and reviewed version pull requests. diff --git a/.changelog/ci-status-permissions.md b/.changelog/ci-status-permissions.md new file mode 100644 index 0000000..6a3ba77 --- /dev/null +++ b/.changelog/ci-status-permissions.md @@ -0,0 +1,6 @@ +--- +category: fixed +type: patch +--- + +Allow the isolated CI status publisher to read workflow job outcomes without granting write permissions to test jobs. diff --git a/.changelog/contextual-artwork.md b/.changelog/contextual-artwork.md new file mode 100644 index 0000000..e232554 --- /dev/null +++ b/.changelog/contextual-artwork.md @@ -0,0 +1,7 @@ +--- +category: changed +type: patch +pull_request: 9 +--- + +Replace the mascot banner with contextual Dash artwork connecting framework modules and align README and documentation references. diff --git a/.changelog/pin-wiki-workflow.md b/.changelog/pin-wiki-workflow.md new file mode 100644 index 0000000..6b949c0 --- /dev/null +++ b/.changelog/pin-wiki-workflow.md @@ -0,0 +1,7 @@ +--- +category: fixed +type: patch +pull_request: 12 +--- + +Pin Wiki publication to the merged DevTools workflow so a squash merge cannot invalidate its source revision. diff --git a/.changelog/wiki-publication.md b/.changelog/wiki-publication.md new file mode 100644 index 0000000..7807861 --- /dev/null +++ b/.changelog/wiki-publication.md @@ -0,0 +1,6 @@ +--- +category: changed +type: patch +--- + +Publish generated Wiki pages directly without tracking the Wiki as a Git submodule. diff --git a/.gitattributes b/.gitattributes index 7b61af9..3f28028 100755 --- a/.gitattributes +++ b/.gitattributes @@ -1,4 +1,5 @@ * text=auto +/.agents/ export-ignore /.dev-tools/ export-ignore /.github/ export-ignore /docs/ export-ignore diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index 48e7a1e..4a0ece9 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -1,49 +1,32 @@ -name: "Fast Forward Changelog" +name: Changelog on: pull_request: - types: [opened, reopened, synchronize] + branches: [main] + types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled] + pull_request_target: - types: [closed] + branches: [main] + types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled, closed] + + push: + branches: [main] + workflow_dispatch: - inputs: - changelog-file: - description: Path to the managed changelog file. - required: false - type: string - default: CHANGELOG.md - project: - description: Optional GitHub Project V2 number used for project-board release transitions. - required: false - type: string - default: '' - version: - description: Optional version to promote. Leave empty to infer from Unreleased. - required: false - type: string - default: '' - release-branch-prefix: - description: Prefix used for release-preparation branches. - required: false - type: string - default: release/v - -permissions: - actions: write - contents: write - pull-requests: write - repository-projects: write + +permissions: {} jobs: changelog: - uses: php-fast-forward/dev-tools/.github/workflows/changelog.yml@main + permissions: + contents: write + pull-requests: write + issues: read + statuses: write + + uses: php-fast-forward/changelog/.github/workflows/changelog.yml@85474de5a16bb08f83c9f30e0ed72f331a210f07 # v0.3.0 + with: - changelog-file: ${{ inputs.changelog-file || 'CHANGELOG.md' }} - # project: 1 - # - # Consumer repositories SHOULD set this when they want changelog-driven - # release transitions to update a specific GitHub Project V2 board. - project: ${{ inputs.project || vars.PROJECT || '' }} - version: ${{ inputs.version || '' }} - release-branch-prefix: ${{ inputs.release-branch-prefix || 'release/v' }} - secrets: inherit + base-branch: main + source: tags + version-pr-title: 'chore(release): framework {current_version} → {next_version}' diff --git a/AGENTS.md b/AGENTS.md index e33af2d..367d03c 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -21,8 +21,9 @@ Fast Forward components through a single provider entry point. - `composer dev-tools` - Apply auto-fixes and generated file synchronization with: - `composer dev-tools:fix` -- Validate changelog discipline on PR branches with: - - `composer dev-tools changelog:check -- --against=refs/remotes/origin/main` +- Read `.agents/skills/fast-forward-changelog/SKILL.md` before changelog work. +- Validate committed PR contributions with PHP 8.5+ and: + - `cpx --skip-local fast-forward/changelog:0.3.0 check --since=origin/main --no-interaction` ## Testing and quality gates @@ -40,5 +41,6 @@ Fast Forward components through a single provider entry point. ## PR and review expectations -- When making user-visible changes, add an entry under `## [Unreleased]` in [`CHANGELOG.md`](CHANGELOG.md). +- When making user-visible changes, add a unique `.changelog/*.md` fragment using the installed Changelog skill and [contribution guide](CONTRIBUTING.md). +- Preserve published `CHANGELOG.md` history. The reviewed version PR consolidates pending fragments; do not add an `Unreleased` heading. - Prefer concise entry wording and include the current PR reference when known. diff --git a/CHANGELOG.md b/CHANGELOG.md index c789c21..23dfae2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,19 +5,6 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] - -### Changed - -- Publish generated Wiki pages directly without tracking the Wiki as a Git submodule. - -- Replace the mascot banner with contextual Dash artwork connecting framework modules and align README and documentation references. (#9) - -### Fixed - -- Pin Wiki publication to the merged DevTools workflow so a squash merge cannot invalidate its source revision. (#12) -- Allow the isolated CI status publisher to read workflow job outcomes without granting write permissions to test jobs. - ## [1.4.0] - 2026-04-25 ### Added @@ -72,7 +59,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Initial package bootstrap, foundational framework scaffolding, and baseline release metadata. -[unreleased]: https://github.com/php-fast-forward/framework/compare/v1.4.0...HEAD [1.4.0]: https://github.com/php-fast-forward/framework/compare/v1.3.0...v1.4.0 [1.3.0]: https://github.com/php-fast-forward/framework/compare/v1.2.1...v1.3.0 [1.2.1]: https://github.com/php-fast-forward/framework/compare/v1.2.0...v1.2.1 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..be970e9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Contributing + +Add one unique `.changelog/*.md` fragment for each observable change. With +PHP 8.5+ and CPX, inspect `help add`, then create and validate the note: + +```sh +cpx --skip-local fast-forward/changelog:0.3.0 add "Describe the observable change." --category=fixed --no-interaction +cpx --skip-local fast-forward/changelog:0.3.0 check --no-interaction +``` + +After committing, validate the contribution with `check --since=origin/main`. +Read [.agents/skills/fast-forward-changelog/SKILL.md](.agents/skills/fast-forward-changelog/SKILL.md) +for the full procedure. Preserve published history and pending notes; do not add +an `Unreleased` section to `CHANGELOG.md`. + +The GitHub workflow checks contributions, maintains PR feedback and prepares a +version PR. Review its exact changes before merging: that approved merge enables +automatic tag and GitHub Release publication. Installing the workflow publishes +nothing. To review a future skill update, use `skill:install --check --json` +with the deliberately selected release, followed by `--update` when appropriate. From 992a45860ed75d6373fc4d2f9f4427aef5c44620 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felipe=20Say=C3=A3o=20Lobato=20Abreu?= Date: Tue, 20 Oct 2026 11:49:38 -0300 Subject: [PATCH 2/3] docs: use the stable CPX command without a version constraint --- AGENTS.md | 2 +- CONTRIBUTING.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 367d03c..bffc133 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -23,7 +23,7 @@ Fast Forward components through a single provider entry point. - `composer dev-tools:fix` - Read `.agents/skills/fast-forward-changelog/SKILL.md` before changelog work. - Validate committed PR contributions with PHP 8.5+ and: - - `cpx --skip-local fast-forward/changelog:0.3.0 check --since=origin/main --no-interaction` + - `cpx --skip-local fast-forward/changelog check --since=origin/main --no-interaction` ## Testing and quality gates diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index be970e9..df9aaca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,8 +4,8 @@ Add one unique `.changelog/*.md` fragment for each observable change. With PHP 8.5+ and CPX, inspect `help add`, then create and validate the note: ```sh -cpx --skip-local fast-forward/changelog:0.3.0 add "Describe the observable change." --category=fixed --no-interaction -cpx --skip-local fast-forward/changelog:0.3.0 check --no-interaction +cpx --skip-local fast-forward/changelog add "Describe the observable change." --category=fixed --no-interaction +cpx --skip-local fast-forward/changelog check --no-interaction ``` After committing, validate the contribution with `check --since=origin/main`. From 9c63347f61e0b716a9e8c60c231506216368c92b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felipe=20Say=C3=A3o=20Lobato=20Abreu?= Date: Tue, 20 Oct 2026 12:27:02 -0300 Subject: [PATCH 3/3] chore: align changelog channel and remove conflict automation --- .changelog/adopt-fast-forward-changelog.md | 2 +- .github/workflows/auto-resolve-conflicts.yml | 36 -------------------- .github/workflows/changelog.yml | 4 +-- 3 files changed, 3 insertions(+), 39 deletions(-) delete mode 100644 .github/workflows/auto-resolve-conflicts.yml diff --git a/.changelog/adopt-fast-forward-changelog.md b/.changelog/adopt-fast-forward-changelog.md index 5e1b2c4..f726bf1 100644 --- a/.changelog/adopt-fast-forward-changelog.md +++ b/.changelog/adopt-fast-forward-changelog.md @@ -3,4 +3,4 @@ category: changed type: patch --- -Adopt Fast Forward Changelog automation and its project skill for validated contribution notes and reviewed version pull requests. +Adopt Fast Forward Changelog automation through its v0 release channel and its project skill for validated contribution notes and reviewed version pull requests titled with the package name and current/next versions. Remove the legacy automatic conflict-resolution workflow now that pending changes use independent fragments. diff --git a/.github/workflows/auto-resolve-conflicts.yml b/.github/workflows/auto-resolve-conflicts.yml deleted file mode 100644 index 0c248f6..0000000 --- a/.github/workflows/auto-resolve-conflicts.yml +++ /dev/null @@ -1,36 +0,0 @@ -name: "Fast Forward Predictable Conflict Resolution" - -on: - push: - branches: [ "main" ] - pull_request: - types: - - opened - - synchronize - - reopened - - ready_for_review - workflow_dispatch: - inputs: - base-ref: - description: Base branch inspected for open pull requests. - required: false - type: string - default: main - pull-request-number: - description: Optional pull request number to inspect. Leave empty to scan open pull requests targeting the base branch. - required: false - type: string - default: '' - -permissions: - actions: write - contents: write - pull-requests: write - -jobs: - auto-resolve-conflicts: - uses: php-fast-forward/dev-tools/.github/workflows/auto-resolve-conflicts.yml@main - with: - base-ref: ${{ inputs.base-ref || github.event.pull_request.base.ref || github.event.repository.default_branch || 'main' }} - pull-request-number: ${{ inputs.pull-request-number || github.event.pull_request.number || '' }} - secrets: inherit diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index 4a0ece9..dc43b7a 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -24,9 +24,9 @@ jobs: issues: read statuses: write - uses: php-fast-forward/changelog/.github/workflows/changelog.yml@85474de5a16bb08f83c9f30e0ed72f331a210f07 # v0.3.0 + uses: php-fast-forward/changelog/.github/workflows/changelog.yml@v0 with: base-branch: main source: tags - version-pr-title: 'chore(release): framework {current_version} → {next_version}' + version-pr-title: 'chore(release): fast-forward/framework v{current_version} → v{next_version}'