Commit bf56c3a9 authored by Rémy Coutable's avatar Rémy Coutable

Merge branch 'docs-add-more-conventions-for-docs-only-tests' into 'master'

Add more choices to name the branch for docs only tests

See merge request !11413
parents e949d6b5 0c59aa0a
...@@ -75,7 +75,7 @@ stages: ...@@ -75,7 +75,7 @@ stages:
# https://docs.gitlab.com/ce/development/writing_documentation.html#testing # https://docs.gitlab.com/ce/development/writing_documentation.html#testing
.except-docs: &except-docs .except-docs: &except-docs
except: except:
- /^docs\/.*/ - /(^docs[\/-].*|.*-docs$)/
.rspec-knapsack: &rspec-knapsack .rspec-knapsack: &rspec-knapsack
stage: test stage: test
...@@ -309,7 +309,7 @@ downtime_check: ...@@ -309,7 +309,7 @@ downtime_check:
- master - master
- tags - tags
- /^[\d-]+-stable(-ee)?$/ - /^[\d-]+-stable(-ee)?$/
- /^docs\/*/ - /(^docs[\/-].*|.*-docs$)/
ee_compat_check: ee_compat_check:
<<: *rake-exec <<: *rake-exec
......
...@@ -78,14 +78,21 @@ Currently GitLab docs use Redcarpet as [markdown](../user/markdown.md) engine, b ...@@ -78,14 +78,21 @@ Currently GitLab docs use Redcarpet as [markdown](../user/markdown.md) engine, b
We try to treat documentation as code, thus have implemented some testing. We try to treat documentation as code, thus have implemented some testing.
Currently, the following tests are in place: Currently, the following tests are in place:
1. `docs:check:links`: Check that all internal (relative) links work correctly 1. `docs lint`: Check that all internal (relative) links work correctly and
1. `docs:check:apilint`: Check that the API docs follow some conventions that all cURL examples in API docs use the full switches.
If your contribution contains **only** documentation changes, you can speed up If your contribution contains **only** documentation changes, you can speed up
the CI process by prepending to the name of your branch: `docs/`. For example, the CI process by following some branch naming conventions. You have three
a valid name would be `docs/update-api-issues` and it will run only the docs choices:
tests. If the name is `docs-update-api-issues`, the whole test suite will run
(including docs). | Branch name | Valid example |
| ----------- | ------------- |
| Starting with `docs/` | `docs/update-api-issues` |
| Starting with `docs-` | `docs-update-api-issues` |
| Ending in `-docs` | `123-update-api-issues-docs` |
If your branch name matches any of the above, it will run only the docs
tests. If it doesn't, the whole test suite will run (including docs).
--- ---
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment