search

equinix-labs / metal-go

[Deprecated] Golang client for Equinix Metal
https://deploy.equinix.com/labs/equinix-sdk-go/
MIT License
3 stars 2 forks source link

Ensure git history has some record of who triggered relevant GitHub Actions #174

Closed ctreatma closed 10 months ago

ctreatma commented 11 months ago

Created from a comment on https://github.com/equinix-labs/metal-go/pull/171#pullrequestreview-1732643199:

Looking at the PR description, it may be helpful to include the user that triggered the action if that is known and can be included in the PR description template (@ tagging that user -- "This API Sync PR was automated through [action link] by @displague on 2023-11-08.").

The workflow_dispatch event payload includes a sender property that has the information we want: https://docs.github.com/en/webhooks/webhook-events-and-payloads#workflow_dispatch

In addition to capturing the sender in the PR description (and/or PR title) for sync PRs, we should also capture the sender for the release job (we could include that in the release description and/or the regenerate code for version <x> commit message).

ctreatma commented 10 months ago

This has been fixed in equinix/equinix-sdk-go and will not be implemented here.