Add gh-pages install script, CIMD metadata, and docs publishing#2
Open
emsearcy wants to merge 1 commit into
Open
Add gh-pages install script, CIMD metadata, and docs publishing#2emsearcy wants to merge 1 commit into
emsearcy wants to merge 1 commit into
Conversation
- Add curl-style install.sh and Auth0 CIMD client-metadata.json on the new gh-pages branch, served via GitHub Pages. - Add a publish-docs job to the release-tag workflow that generates Markdown CLI reference docs via 'lfx docs' and publishes them to gh-pages/docs/cli.md on every tagged release. - Document the curl-style installer as the primary install method in the README, with go install as an alternative. - Document the gh-pages branch and its maintenance in AGENTS.md. Assisted-by: github-copilot:claude-sonnet-5 Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
There was a problem hiding this comment.
Pull request overview
Integrates the gh-pages installer, CIMD metadata, and generated CLI documentation into the project’s installation and release workflows.
Changes:
- Makes the hosted installer the primary installation method.
- Documents
gh-pagesassets and maintenance. - Publishes generated CLI docs after tagged releases.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
README.md |
Documents installer usage and alternatives. |
AGENTS.md |
Documents gh-pages assets and maintenance. |
.github/workflows/release-tag.yml |
Adds automated CLI documentation publishing. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
Sets up the
gh-pagesbranch to serve the curl-style installer, Auth0 CIMD client metadata, and auto-generated CLI reference docs, per LFXV2-2512.install.shongh-pages(root): detects OS/arch, downloads the matching release archive from GitHub Releases, verifies its checksum, and installs to/usr/local/bin(falling back to~/.local/binif not writable). Verified manually against the realv0.0.1release, including the writable/non-writable install-dir fallback and a bad-version failure path.client-metadata.jsonongh-pages: the CIMD (Client ID Metadata Document) for the LFX CLI's Auth0 Device Code client (this URL is the client_id). The correspondingauth0-terraformclient is tracked separately in LFXV2-2513.publish-docsjob to.github/workflows/release-tag.ymlthat runslfx docsand publishesdocs/cli.mdtogh-pageson every tagged release.go installas an alternative).gh-pagesbranch and its maintenance inAGENTS.md.Test plan
go build ./...,go vet ./...,gofmt -l .all cleanshellcheckandshfmt -dclean oninstall.shinstall.shagainst the realv0.0.1release: default writable-dir path, non-writable-dir fallback to~/.local/bin, and a bad-version 404 failure pathinstall.shandclient-metadata.jsonare live athttps://linuxfoundation.github.io/lfx-cli/publish-docsjob succeeds on the next tagged release (can't be tested until then)🤖 Generated with GitHub Copilot (via OpenCode)