Skip to content

Sync "Check Certificates" GitHub Actions workflow with template #655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 16, 2021
Merged

Sync "Check Certificates" GitHub Actions workflow with template #655

merged 7 commits into from
Aug 16, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 13, 2021

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • Tests for the changes have been added (for bug fixes / features)
  • What kind of change does this PR introduce?

Infrastructure update

  • What is the current behavior?

We have assembled a collection of reusable GitHub Actions workflows:
https://github.com/arduino/tooling-project-assets
These workflows will be used in the repositories of all Arduino tooling projects.

Some minor improvements and standardizations have been made in the upstream "template" workflow, but those have not yet been pulled into this repository.

  • What is the new behavior?

Workflow is synced with the state of the art from upstream.

  • Does this PR introduce a breaking change?

Not breaking

  • Other information:

This is the naming convention established in the standardized template workflow.
The `repository_dispatch` event allows triggering workflows via the GitHub API. This might be useful for triggering an
immediate check in multiple relevant repositories after an external change, or some automated process. Although we don't
have any specific need for this event at the moment, the event has no impact on the workflow, so there is no reason
against having it. It is the sort of thing that can end up being useful if it is already in consistently in place, but
not worth setting up on demand, since the effort to set it up is greater than the effort to trigger all the workflows
manually.
This will facilitate testing and review of modifications to the workflow.

Because the workflow requires access to repository secrets, and so will fail whenever triggered by an event from a fork,
a conditional is added to make it only run when the modifications are made within the `arduino/arduino-create-agent`
repository.
No functional change, and neither is necessarily superior, but this is how it is in the "template", and so it must be
here as well.
When no name is provided for a matrix job, the workflow job is named according to the contents of
`jobs[].<job_id>.strategy.matrix[]`. That can result in some fairly cryptic job names when the matrix contains a complex
data structure as is the case here. We already have a string to uniquely identify each certificate to humans, which is
exactly what the `jobs[].<job_id>.name` property does for jobs, so it will be an improvement to name the jobs according
to that identifier.
No functional change, and neither is necessarily superior, but this is how it is in the "template", and so it must be
here as well.
This will make it easier for the maintainers to sync fixes and improvements in either direction between the upstream
"template" workflow and its installation in this repository.
@per1234 per1234 merged commit 3bdd07d into arduino:main Aug 16, 2021
@per1234 per1234 deleted the sync-check-certificates branch August 16, 2021 07:47
@per1234 per1234 added the topic: infrastructure Related to project infrastructure label Sep 24, 2021
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants