Skip to content

Run Go module configuration sync check also on docsgen module #224

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 1 commit into from
Aug 4, 2021
Merged

Run Go module configuration sync check also on docsgen module #224

merged 1 commit into from
Aug 4, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 4, 2021

The check-config job of the "Check Go" workflow runs a check to see whether there were any missed updates to the
go.mod and go.sum files. Previously, this was only done for the main module. But there is an additional module for
generating the website's command reference content the update of which might easily be overlooked. The CI check was not
applied to this module, which could allow its metadata to get out of date.

The use of a job matrix allows the workflow to easily accomodate the future addition of more modules to the repository by
simply adding their path to the matrix array.

@per1234 per1234 added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure labels Aug 4, 2021
@per1234 per1234 requested review from silvanocerza and umbynos August 4, 2021 05:41
The `check-config` job of the "Check Go" workflow runs a check to see whether there were any missed updates to the
`go.mod` and `go.sum` files. Previously, this was only done for the main module. But there is an additional module for
generating the website's command reference content the update of which might easily be overlooked. The CI check was not
applied to this module, which could allow its metadata to get out of date.

The use of a job matrix allows the workflow to easily accomodate the future addition of more modules to the repository by
simply adding their path to the matrix array.
@per1234 per1234 merged commit 3b32708 into arduino:main Aug 4, 2021
@per1234 per1234 deleted the check-multi-module branch August 4, 2021 09:12
@per1234 per1234 self-assigned this Nov 20, 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