Repository navigation
docs(relctl): generated CLI reference, sync workflow, 2.11.0 updates and logo - #24
Merged
Merged
Conversation
… and logo - Regenerate docs/relctl/cli/ with the released relctl 2.11.0 (relctl docs). - Add the Sync relctl CLI reference workflow (weekly, manual, repository_dispatch). - Fix the CalVer format (YYYYMM.D.N); document version variables, tag_prefix, components, release changed and pr info per scheme; fix the manual download. - Add the relctl logo assets and show the lockup on the relctl intro page.
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.
What
docs/relctl/cli/regenerated withrelctl docs --outfrom the released relctl 2.11.0 binary (relctl_2.11.0_linux-amd64, SHA-256 verified against the release'ssha256sum.txt). Stale hand-written content is gone;_category_.jsonis kept.sync-cli-reference.yml(weekly,workflow_dispatch,repository_dispatchtyperelctl-release): fetches the latest published relctl release, verifies the checksum, regenerates the pages and, if they differ, force-updates the branchchore/cli-referenceand opens or updates one pull request. Permissions:contents: write,pull-requests: write, plusactions: writeonly to startCIon the branch (pushes withGITHUB_TOKENdo not triggerCI, butworkflow_dispatchis allowed; the run attaches to the branch head commit and shows as a check on the PR). No third-party actions;actions/checkout@v7as elsewhere in the repo. Not merged automatically.YYYYMM.D.N(day without leading zero) in usage, intro, FAQ and version schemes (wasYYYY.MM.DD.N/YYYYMM.DD.N).usage.md: removed the outdated hand-written flag reference (the generated CLI reference replaces it); addedpr infoper scheme, components andrelease changed, and the version variables table.configuration.md:tag_prefixandcomponents.version-schemes.md,ci-integration.md,supported-systems.md:RELCTL_VERSION,RELCTL_NEXT_VERSION,RELCTL_LATEST_VERSION,RELCTL_PRERELEASE,RELCTL_TAG,RELCTL_COMPONENT; tag prefix and components.installation.md,ci-integration.md: the manual download usedrelctl_linux-amd64, which does not exist; assets are namedrelctl_<version>_<os>-<arch>. The example now resolves the version and checks the SHA-256.static/img/relctl/; the lockup (dark/light variants) is shown on the relctl intro page. The navbar logo and favicon stay Layer87, because the site is the hub for several products.Checks (local)
pnpm run typecheck,pnpm run lint:md(0 issues),pnpm run build(no[WARNING]),pnpm test(14 passed, 1 skipped).