docs: add FAQ entry on forwarding agent/detection artifacts post-conclusion#30278
Merged
docs: add FAQ entry on forwarding agent/detection artifacts post-conclusion#30278
Conversation
…lusion Agent-Logs-Url: https://github.com/github/gh-aw/sessions/de455966-a8d7-4ac7-afe8-a1c986ebbb19 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
…example Agent-Logs-Url: https://github.com/github/gh-aw/sessions/de455966-a8d7-4ac7-afe8-a1c986ebbb19 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
pelikhan
May 5, 2026 05:03
View session
pelikhan
reviewed
May 5, 2026
| if: always() | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Download artifacts |
Collaborator
There was a problem hiding this comment.
@copilot use actions/download artifact instead of gh
Contributor
Author
There was a problem hiding this comment.
Done in bfe0222 — replaced both gh run download calls with actions/download-artifact@v4 steps. The detection step has continue-on-error: true to handle the case where that artifact is absent.
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/066857dd-ead3-4f8c-a939-54e8b14f56a9 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
pelikhan
approved these changes
May 5, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new FAQ entry in the Workflow Design section documenting how to run a post-workflow job to download agent / optional detection artifacts and forward them to an external ingest endpoint.
Changes:
- Documented using
needs: [conclusion]to ensure built-in jobs/artifact uploads finish before a custom forwarding job runs. - Provided a minimal YAML example that downloads artifacts, archives them, and POSTs them via
curl. - Added pointers to the Artifacts and Threat Detection references for more detail.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/reference/faq.md | Adds an FAQ entry with a concrete example job for downloading and forwarding artifacts after workflow completion. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
| run: | | ||
| tar -czf artifacts.tar.gz artifacts/ | ||
| curl --fail --retry 3 -X POST https://ingest.example.com/artifacts \ | ||
| -H "Authorization: ******" \ |
Comment on lines
+625
to
+630
| - uses: actions/download-artifact@v4 | ||
| with: | ||
| name: detection | ||
| path: artifacts/detection | ||
| continue-on-error: true | ||
| - name: Upload to third-party server |
This was referenced May 5, 2026
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.
Adds a focused FAQ entry to the Workflow Design section answering:
The entry shows a minimal custom job that:
needs: [conclusion]so it runs after all built-in jobs completeif: always()to run even on agent failureagentartifact (always present) and thedetectionartifact (|| trueguards against it being absent when threat detection is disabled)--retry 3Links to the Artifacts reference and Threat Detection reference for further reading.