Skip to content

docs: add FAQ entry on forwarding agent/detection artifacts post-conclusion - #30278

Merged
pelikhan merged 3 commits into
mainfrom
copilot/add-faq-entry-job-dependency
May 5, 2026
Merged

docs: add FAQ entry on forwarding agent/detection artifacts post-conclusion#30278
pelikhan merged 3 commits into
mainfrom
copilot/add-faq-entry-job-dependency

Conversation

CopilotAI commented May 5, 2026

Copy link
Copy Markdown
Contributor

Adds a focused FAQ entry to the Workflow Design section answering:

How do I forward agent and detection artifacts to a third-party server after the workflow finishes?

The entry shows a minimal custom job that:

  • declares needs: [conclusion] so it runs after all built-in jobs complete
  • uses if: always() to run even on agent failure
  • downloads the agent artifact (always present) and the detection artifact (|| true guards against it being absent when threat detection is disabled)
  • archives and POSTs everything to an external ingest endpoint with --retry 3

Links to the Artifacts reference and Threat Detection reference for further reading.

CopilotAIand others added 2 commits May 5, 2026 05:02
if: always()
runs-on: ubuntu-latest
steps:
- name: Download artifacts

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@copilot use actions/download artifact instead of gh

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

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.

CopilotAI requested a review from pelikhanMay 5, 2026 05:17
@pelikhan
pelikhan marked this pull request as ready for review May 5, 2026 05:25
CopilotAI review requested due to automatic review settings May 5, 2026 05:25
@pelikhan
pelikhan merged commit 18fc8fe into mainMay 5, 2026
@pelikhan
pelikhan deleted the copilot/add-faq-entry-job-dependency branch May 5, 2026 05:26

CopilotAI 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.

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
FileDescription
docs/src/content/docs/reference/faq.mdAdds 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
Sign up for freeto 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.

3 participants

@pelikhan