Skip to content

Commit

Permalink
don't tell documentation contributors to skip CI
Browse files Browse the repository at this point in the history
The CI correctly handles documentation changes automatically, it's no
longer necessary to do it by hand.
  • Loading branch information
guijan authored and eli-schwartz committed May 27, 2022
1 parent fda4c49 commit 3c66be0
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 15 deletions.
8 changes: 0 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,3 @@ You can simply run:
```
$ ninja -C built_docs/ upload
```

## Contributing to the documentation

Commits that only change documentation should have `[skip ci]` in their commit message, so CI is not run (it is quite slow).
For example:
```
A commit message [skip ci]
```
5 changes: 0 additions & 5 deletions docs/markdown/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -462,11 +462,6 @@ notes. These features should be written in standalone files in the
`docs/markdown/snippets` directory. The release manager will combine
them into one page when doing the release.

[Integration tests should be disabled](#skipping-integration-tests) for
documentation-only commits by putting `[skip ci]` into commit title.
Reviewers should ask contributors to put `[skip ci]` into the title because
tests are run again after merge for `master`.

## Python Coding style

Meson follows the basic Python coding style. Additional rules are the
Expand Down
3 changes: 1 addition & 2 deletions skip_ci.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,7 @@ def main():
if args.base_branch_origin:
base = 'origin/' + base
if all(is_documentation(f) for f in get_git_files(base)):
print("Don't run CI for documentation-only changes, add '[skip ci]' to commit title.")
print('See http://mesonbuild.com/Contributing.html#skipping-integration-tests')
print("Documentation change, CI skipped.")
sys.exit(1)
except Exception:
# If this script fails we want build to proceed.
Expand Down

0 comments on commit 3c66be0

Please sign in to comment.