Skip to content

Commit 9ba13aa

Browse files
authored
Continuous integration consolidation (#1711)
* Consolidate continuous integration documentation * Exclude plone.restapi installed stuff from docs
1 parent f743b3a commit 9ba13aa

File tree

6 files changed

+27
-10
lines changed

6 files changed

+27
-10
lines changed

docs/_inc/_continuous-integration.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Plone project repositories use {term}`continuous integration` (CI) to run tests, ensure code quality, or provide previews for every contribution.
2+
Plone uses GitHub workflows, Jenkins, Cypress, Read the Docs, and other services for CI.
3+
All of a project's CI jobs must pass before a contribution may be accepted.
4+
5+
```{seealso}
6+
{doc}`/contributing/core/continuous-integration`
7+
```

docs/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,15 +125,21 @@
125125
"**/CONTRIBUTORS.rst",
126126
"**/LICENSE.rst",
127127
"**/README.rst",
128+
"**/eggs",
129+
"_inc/.*",
128130
"plone.restapi/.*",
129131
"plone.restapi/bin",
132+
"plone.restapi/develop-eggs",
130133
"plone.restapi/docs/source/glossary.md", # There can be only one Glossary.
134+
"plone.restapi/eggs",
131135
"plone.restapi/ideas",
132136
"plone.restapi/include",
133137
"plone.restapi/lib",
134138
"plone.restapi/news",
139+
"plone.restapi/parts",
135140
"plone.restapi/performance",
136141
"plone.restapi/src",
142+
"plone.restapi/var",
137143
"volto/contributing/branch-policy.md",
138144
"volto/contributing/install-docker.md",
139145
"volto/contributing/install-git.md",

docs/contributing/core/continuous-integration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ Otherwise GitHub workflows do not run automatically, and require a member with w
2727
GitHub workflows should pass before running Jenkins checks and before merging an open pull request.
2828

2929

30+
## `mr-roboto`
31+
32+
[`mr-roboto`](https://github.com/plone/mr.roboto) enforces the requirement of a signed Plone Contributor Agreement from a new contributor, and being assigned to a Plone team on GitHub.
33+
It also suggests to run Jenkins for many Plone packages.
34+
35+
3036
## Jenkins
3137

3238
[Jenkins](https://jenkins.plone.org) is the authoritative source to see whether the complete test suite passes for any Plone version under development.

docs/contributing/core/index.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -292,14 +292,10 @@ This enables automatic closing of the related issue when the pull request is mer
292292
This also creates a hyperlink to the original issue for easy reference.
293293

294294

295-
## Jenkins and mr.roboto
295+
## Continuous integration
296296

297-
Plone has a continuous integration ({term}`CI`) setup and follows CI rules.
298-
299-
When you push a change to a Plone package, there may be GitHub workflows that run automatically.
300-
The CI package [mr.roboto](https://github.com/plone/mr.roboto) will perform some checks and suggest that you run Jenkins after all other CI runs.
301-
302-
See {doc}`continuous-integration` for more information.
297+
```{include} /_inc/_continuous-integration.md
298+
```
303299

304300

305301
## Additional material

docs/contributing/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,13 @@ All contributors to the Plone Documentation follow the Code of Conduct.
6060

6161
First-time contributors should read and follow our guide {doc}`first-time`.
6262

63+
6364
(contributing-continuous-integration-label)=
6465

6566
## Continuous integration
6667

67-
Plone project repositories use continuous integration (CI) to run tests, ensure code quality, or provide previews for every contribution.
68-
Plone uses GitHub Actions, Jenkins, Cypress, Netlify, and other services for CI.
69-
All of a project's CI jobs must pass before a contribution may be accepted.
68+
```{include} /_inc/_continuous-integration.md
69+
```
7070

7171
(contributing-change-log-label)=
7272

docs/glossary.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -756,6 +756,8 @@ Load balancer
756756
CI
757757
continuous integration
758758
Continuous integration (CI) is the practice of integrating all your code changes into the main branch of a shared source code repository early and often, automatically testing each change when you commit or merge them, and automatically kicking off a build.
759+
760+
Read about Plone's {doc}`/contributing/core/continuous-integration`.
759761
760762
CD
761763
continuous deployment

0 commit comments

Comments
 (0)