You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 700.en.adoc
+14-5Lines changed: 14 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ NOTE: This section is technical information for GBIF software developers maintai
6
6
7
7
To make a new document:
8
8
9
-
* Create a new repository using the https://github.com/gbif/doc-template[doc-template] template repository (”Use this template”), with a name beginning with `doc-`.
9
+
* Create a new repository using the https://github.com/gbif/doc-template[doc-template] template repository (”Use this template”), with a name beginning with `doc-`, or `course-` for a training course.
10
10
* Edit the `README.adoc` to update the links, license, DOI etc.
11
11
* Set the branch name appropriately (`1.0`), if published versions of the document should be retained
12
12
* Add a new job to Jenkins,
@@ -16,24 +16,33 @@ To make a new document:
16
16
17
17
* Create a new job, based on:
18
18
** the existing `doc-template` job, for unversioned documents
19
-
** the existing `doc-effective-nodes-guidance` job, for versioned documents
19
+
** the existing `doc-test-document` job, for versioned documents
20
20
21
21
+
22
22
You need to change the Git repository paths (“Source Code Management” section)
23
23
24
24
* Change the `Authentication Token` to something new (“Build Triggers” section)
25
-
* Within GitHub, set up a new webhook with the path e.g. `pass:[http://builds.gbif.org/job/doc-XXXXXXXXXXXX/buildWithParameters?token=XXXXXXXXXX]` (with the token from the previous step)
26
-
** The secret text seems not to matter
25
+
* Within GitHub, set up a new webhook with the path:
** Select the individual events `Pushes` and `Releases`
28
32
29
33
.Full Jenkins configuration
30
34
[%collapsible]
31
35
====
32
36
These things will have been copied across from the existing build:
33
37
38
+
* Discard old builds: 15
39
+
* GitHub project
34
40
* A `payload` parameter to receive information from GitHub.
35
41
* *Source Code Management*: Under advanced Git settings, set the branches to build to `origin/*` and `Check out to specific local branch` to `+**+`. This supports versioned documents, and updating the translation index.
36
-
* Set a build script, which varies depending whether the document is keeping old versions deployed.
42
+
* A build script, either `VERSIONED=true /usr/local/bin/document-build-deploy` or just `/usr/local/bin/document-build-deploy`.
43
+
* Git Publisher post-build action: to merge changes to the translation index.
44
+
* Set GitHub commit status (so users can see if they have committed invalid syntax).
0 commit comments