Skip to content

docs: add GitHub Action consumer example - #127

Closed
PandaHUN777 wants to merge 1 commit into
AETHERXGLOBAL:mainfrom
PandaHUN777:panda/issue-123-github-action-consumer
Closed

PandaHUN777 wants to merge 1 commit into
AETHERXGLOBAL:mainfrom
PandaHUN777:panda/issue-123-github-action-consumer

Conversation

@PandaHUN777

Copy link
Copy Markdown
Contributor

Adds a copy-ready consumer workflow using the public v0.1 channel and documents the immutable Alpha.5 review pin. Shows explicit baseline setup and fail-closed PASS, REVIEW, BLOCK, and ERROR handling, and links to the Action guide.\n\nCloses #123\n\nValidation: actionlint examples/github-action-consumer.yml; git diff --check.

@aetherxeg-source aetherxeg-source left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small but real portability issue before merge: examples/github-action-consumer.yml is explicitly intended to be copied into an external consumer repository, but its header says Full behavior and limitations: ../docs/GITHUB_ACTION.md. After copying, that relative path points into the consumer repository and will normally be broken. Please replace it with the canonical upstream ExecSurface documentation URL (or another copy-safe reference). The Action inputs/verdict handling otherwise look consistent with the current contract.

@aetherxeg-source aetherxeg-source left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One additional freshness note while this is being corrected: the branch is now 10 commits behind current main (013f26ee5d0e395e555635e5dc03f222dde07268), including changes to the GitHub Action/public-consumer qualification path and docs/GITHUB_ACTION.md. Please sync with current main together with the previously requested copy-safe documentation URL fix, then let fresh CI run on the updated head. The prior Action/verdict-handling review remains otherwise unchanged.

Copy link
Copy Markdown
Contributor

Maintainer triage — stable v1.0.0 alignment (not a rejection)

Thank you for contributing a copy-ready GitHub Actions consumer example. It remains useful, but main has now published stable v1.0.0, and this PR is still pinned to historical @v0.1 / Alpha.5. Before merge, please either (A) update the active copy-ready example to the currently supported @v1 contract or (B) explicitly label it as a historical Alpha example and place it in an archival section. We should not install an obsolete channel as the default for a new consumer.

The previously requested portability correction remains: replace the copy-unsafe relative ../docs/GITHUB_ACTION.md reference inside the copied workflow with its canonical absolute upstream URL. Also sync with current main, run the real public consumer Action test with actual PASS/REVIEW/BLOCK/ERROR outputs, and confirm the selected baseline does not mutate. Keep least-privilege token permissions.

No history or negative result should be rewritten. A maintainer can help with an explicit scoped follow-up if a rebase is inconvenient. We will assess the updated head rather than merge stale evidence.

Copy link
Copy Markdown
Contributor

Thank you @PandaHUN777 for contributing the original copy-ready GitHub Action consumer direction and for the careful Alpha.5 draft. Since the submission, ExecSurface has published stable v1.0.0 and qualified its supported @v1 channel. To avoid leaving new consumers with the obsolete @v0.1 default, the maintainers have now merged a separate, current-v1 consumer example in PR #188: copy-ready @v1 workflow.

The v1 example preserves the useful intent of this submission, while adding the independent native test-success gate, explicit trusted baseline/policy custody pins, copy-safe documentation URL and fail-closed REVIEW behavior. The published examples index explicitly credits your original proposal. Its public @v1 PASS/REVIEW/BLOCK/ERROR CI qualification passed in run #37956199333.

We are closing this historical Alpha-targeted PR as superseded, not rejected—no need to spend more work rebasing it against a replaced support channel. Thank you for the contribution and the initial design. Fresh v1 improvements or counterexamples remain welcome in a new focused PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants