README: stop teaching the patterns we removed everywhere else - #10
Open
pavel-te wants to merge 1 commit into
Open
README: stop teaching the patterns we removed everywhere else#10pavel-te wants to merge 1 commit into
pavel-te wants to merge 1 commit into
Conversation
The CI/CD section still described the world before ptc-action, and every defect it taught is one we fixed elsewhere and then shipped a doc contradicting. - The GitHub Actions example was a hand-rolled job with peter-evans/create-pull-request@v5 — an unpinned movable tag on a third-party action, i.e. a write-access foothold. It now leads with ptc-action; the manual steps survive in a <details> block with the SHA pin, the sha256 check and the stable ptc/translations branch, so a reader who genuinely needs them gets the safe version. - Pins said v1.0.0 while v1.0.3 is current, and the "verify against the checksum published on the release page" instruction had no checksum to point at. The sha256 is now inline next to the curl. - The example config was .ptc/config.yml; `ptc init` writes .ptc-config.yml at the repository root, which is also the path the action auto-detects. - The GitLab job did `chmod +x ptc-cli.sh` on a file it never downloaded, had no image (so no bash on a default Alpine runner), never pushed anything, and gated on the deprecated `only:`. Replaced with the job `ptc init` prints, including the PTC_GIT_PUSH_TOKEN fallback and the [skip ci] guard, plus the note that a Catalog component can never resolve cross-instance. No behaviour change; 180 tests still green (12 + 72 + 22 + 22 + 52).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The CI/CD section still described the world before ptc-action, and every
defect it taught is one we fixed elsewhere and then shipped a doc
contradicting.
peter-evans/create-pull-request@v5 — an unpinned movable tag on a
third-party action, i.e. a write-access foothold. It now leads with
ptc-action; the manual steps survive in a
Details
block with the SHA pin,the sha256 check and the stable ptc/translations branch, so a reader who
genuinely needs them gets the safe version.
checksum published on the release page" instruction had no checksum to
point at. The sha256 is now inline next to the curl.
ptc initwrites .ptc-config.ymlat the repository root, which is also the path the action auto-detects.
chmod +x ptc-cli.shon a file it never downloaded, hadno image (so no bash on a default Alpine runner), never pushed anything, and
gated on the deprecated
only:. Replaced with the jobptc initprints,including the PTC_GIT_PUSH_TOKEN fallback and the [skip ci] guard, plus the
note that a Catalog component can never resolve cross-instance.
No behaviour change; 180 tests still green (12 + 72 + 22 + 22 + 52).