Skip to content
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

Disable some CI checks on docs updates #2076

Merged
merged 2 commits into from
Jun 9, 2023

Conversation

thomas-bc
Copy link
Collaborator

@thomas-bc thomas-bc commented Jun 8, 2023

Originating Project/Creator
Affected Component
Affected Architectures(s) CI
Related Issue(s)
Has Unit Tests (y/n)
Builds Without Errors (y/n)
Unit Tests Pass (y/n)
Documentation Included (y/n)

Change description

Disable the build/test/static code analysis checks on PRs that only touch docs/** and **.md files.

Rationale

We often get PRs on documentation, which trigger the entire CI check suite. I propose we disable some of those checks on these occasions, which are computationally intensive and quite irrelevant. They also slow down the review process for PRs that could be merged in a matter of minutes.

A case against this PR:

Sometimes checks will fail on documentation PRs for reasons that are unrelated (e.g. the RPI agents are unavailable, something broke upstream/fprime-tools etc...).
The case could be made that we should know as soon as possible when this happens, and therefore we should not disable those checks. Which I don't disagree with tbh. This is up for debate, totally fine if we don't want to accept this change.

Copy link
Collaborator

@LeStarch LeStarch left a comment

Choose a reason for hiding this comment

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

I love this!

Another case against this PR could be "what if someone adds a check (e.g. broken link scan) to an existing action. It might not get triggered".

I don't but that argument nor the one you presented. I think, however; we should always run python and spelling checks....see inline comment.

.github/workflows/python-format.yml Outdated Show resolved Hide resolved
@thomas-bc
Copy link
Collaborator Author

thomas-bc commented Jun 8, 2023

Agreed. If we get to modifying workflows down the line, the restriction can always be reversed. Workflows should be tightly scoped though, adding URL checks within a build workflow would be -in my humble opinion- a questionable design.

@thomas-bc thomas-bc merged commit 49d8e91 into nasa:devel Jun 9, 2023
Boehm-Michael pushed a commit to Boehm-Michael/fprime that referenced this pull request Jun 22, 2023
* ignore docs/ and **.md

* always trigger python-format
thomas-bc added a commit that referenced this pull request Aug 4, 2023
* ignore docs/ and **.md

* always trigger python-format
thomas-bc added a commit that referenced this pull request Aug 4, 2023
@thomas-bc thomas-bc deleted the workflow/ignore-md branch September 29, 2023 23:23
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