Skip to content

Document how to skip CI in the contributing guides #908

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

Closed
seisman opened this issue Feb 16, 2021 · 5 comments
Closed

Document how to skip CI in the contributing guides #908

seisman opened this issue Feb 16, 2021 · 5 comments
Labels
help wanted Helping hands are appreciated
Milestone

Comments

@seisman
Copy link
Member

seisman commented Feb 16, 2021

https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/

GitHub Actions now supports skipping push and pull_request workflows by looking for some common keywords in your commit message.

If any commit message in your push or the HEAD commit of your PR contains the strings [skip ci], [ci skip], [no ci], [skip actions], or [actions skip] workflows triggered on the push or pull_request events will be skipped.

Finally, GitHub support skipping workflows to save CI resources! Will try how it looks like in next pushes/PRs. If it works well, we should document it in the contributing guides at CONTRIBUTING.md, and even in the Pull Request template.

@weiji14
Copy link
Member

weiji14 commented Feb 16, 2021

Actually, do you want to just document this in MAINTENANCE.md at the current PR #906?

@seisman
Copy link
Member Author

seisman commented Feb 16, 2021

Better to do one simple thing in one PR.

@willschlitzer willschlitzer added good first issue Good for newcomers help wanted Helping hands are appreciated labels Feb 16, 2021
@seisman seisman added this to the 0.3.1 milestone Feb 16, 2021
@seisman
Copy link
Member Author

seisman commented Feb 21, 2021

One note: when we merge a PR, we should be cautious that the merge message (default to be a list of commit messages in this branch) can't contain [ci skip], otherwise the merged commit won't trigger CI jobs when merged into master branch.

@weiji14
Copy link
Member

weiji14 commented May 1, 2021

Just checking, do you think it's really necessary to document this in our guide (since it's getting quite long)? Or can we just point it out to people (on a need to know basis) and close this issue?

@seisman
Copy link
Member Author

seisman commented May 1, 2021

OK with closing the issue.

@seisman seisman closed this as completed May 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Helping hands are appreciated
Projects
None yet
Development

No branches or pull requests

3 participants