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

[DOC]: Mention skip-tests convention for commits that should not trigger CI in ci-overview #277

Closed
1 task done
wence- opened this issue Jul 27, 2023 · 2 comments
Closed
1 task done
Assignees
Labels
needs triage Issues that require the team's attention

Comments

@wence-
Copy link
Contributor

wence- commented Jul 27, 2023

Is this a duplicate?

Is this for new documentation, or an update to existing docs?

Update

Describe the incorrect/future/missing documentation

As seen in discussion in #274, if a PR only updates the docs, it is recommended to add [skip-tests] to the commit message to avoid running CI on a change that doesn't need it (modulo perhaps building the docs to check nothing is broken?). However, this is not a discoverable feature for a casual contributor (it's only by reading the dispatch workflow that you can determine how this works).

Aside, one might be able to take advantage of either workflow-level path skipping, or else a third-party workflow to job level path filter to automate skipping of expensive CI for docs only changes.

If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

No response

@github-actions
Copy link
Contributor

Hi @wence-!

Thanks for submitting this issue - the CCCL team has been notified and we'll get back to you as soon as we can!
In the mean time, feel free to add any relevant information to this issue.

@github-actions github-actions bot added the needs triage Issues that require the team's attention label Jul 27, 2023
@jrhemstad
Copy link
Collaborator

Closed by #500

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs triage Issues that require the team's attention
Projects
Archived in project
Development

No branches or pull requests

2 participants