Skip to content

Include telemetry tags so we can track usage of the action#42

Merged
derekmisler merged 1 commit intodocker:mainfrom
derekmisler:pass-in-telemetrytags
Feb 13, 2026
Merged

Include telemetry tags so we can track usage of the action#42
derekmisler merged 1 commit intodocker:mainfrom
derekmisler:pass-in-telemetrytags

Conversation

@derekmisler
Copy link
Contributor

@derekmisler derekmisler commented Feb 13, 2026

Closes https://github.com/docker/gordon/issues/121

Summary

Adds telemetry tags to the GitHub Action to enable tracking of action usage across repositories and workflows. The tags include source identifier, repository name, workflow name, and run ID.

Changes

  • action.yml: Added TELEMETRY_TAGS environment variable with GitHub context values (repository, workflow, run_id) to track action usage

Breaking Changes

None

How to Test

  • Run the action in any workflow and verify the telemetry tags are properly passed through
  • Check that the tags contain the expected GitHub context values: repository name, workflow name, and run ID

@derekmisler derekmisler self-assigned this Feb 13, 2026
@derekmisler
Copy link
Contributor Author

/describe

@docker-agent
Copy link

docker-agent bot commented Feb 13, 2026

✅ PR description has been generated and updated!

@derekmisler derekmisler marked this pull request as ready for review February 13, 2026 17:54
@derekmisler derekmisler requested a review from a team as a code owner February 13, 2026 17:54
Copy link

@docker-agent docker-agent bot left a comment

Choose a reason for hiding this comment

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

Code Review Summary

No issues found - The added telemetry tags are properly formatted and safe.

Review Details

I reviewed the addition of TELEMETRY_TAGS environment variable on line 429. The implementation correctly uses GitHub context variables (github.repository, github.workflow, github.run_id) in a comma-separated key=value format.

Security Analysis: GitHub enforces strict constraints on these context variables:

  • github.repository: Only alphanumeric characters, hyphens, and underscores
  • github.workflow: Can contain spaces, hyphens, underscores (no commas or equals signs)
  • github.run_id: Always numeric

These constraints prevent any injection attacks or format-breaking characters, making the implementation safe as-is.

Recommendation: Approved - the code is correct and secure for its intended purpose.

Signed-off-by: Derek Misler <derek.misler@docker.com>
@derekmisler derekmisler force-pushed the pass-in-telemetrytags branch from 2f4e17e to 334c6b3 Compare February 13, 2026 17:58
@derekmisler derekmisler merged commit 7603660 into docker:main Feb 13, 2026
8 checks passed
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