Skip to content

Commit cbdcd07

Browse files
committed
update docs for CI config [skip ci]
- fix name of pipeline in docs - update instructions for configuring pipeline
1 parent 3e0c6b3 commit cbdcd07

File tree

2 files changed

+12
-14
lines changed

2 files changed

+12
-14
lines changed

Jenkinsfile

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
#!/bin/env groovy
22

33
def githubApiTokenCredentialsId = 'docs-robot-api-key'
4-
54
def githubApiTokenCredentials = string(credentialsId: githubApiTokenCredentialsId, variable: 'GITHUB_API_TOKEN')
65

76
// Jenkins job configuration
87
// -------------------------
98
// Category: Multibranch Pipeline
10-
// Pipeline name: release-docs-ui-bundle
9+
// Pipeline name: docs-ui-sandbox
1110
// Branch Sources: Single repository & branch
12-
// Name: master
11+
// Name: cloud
1312
// Source Code Management: Git
14-
// Repository URL: https://github.com/couchbase/docs-ui
13+
// Repository URL: https://github.com/couchbase/docs-ui-sandbox
1514
// Credentials: - none -
16-
// Refspec: +refs/heads/master:refs/remotes/origin/master
17-
// Branch specifier: refs/heads/master
18-
// Advanced clone behaviors: [ ] Fetch tags, [x] Honor refspec on initial clone, [x] Shallow clone (depth: 3)
19-
// Polling ignores commits with certain messages: (?s)(?:Release v\d+|.*\[skip .+?\]).*
15+
// Branch specifier: refs/heads/cloud
16+
// Advanced clone behaviors: [ ] Fetch tags, [x] Honor refspec on initial clone, [x] Shallow clone, Shallow clone depth: 5
17+
// Polling ignores commits with certain messages: (?s)(?:Release |.*\[skip .+?\]).*
2018
// Build Configuration:
2119
// Mode: by Jenkinsfile
2220
// Script Path: Jenkinsfile

README.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ If you need to package the UI so you can use it to generate the documentation si
198198
If any errors are reported by lint, you'll need to fix them.
199199

200200
When the command completes successfully, the UI bundle will be available at [.path]_build/ui-bundle.zip_.
201-
You can point Antora at this bundle using the `--ui-bundle-url` command-line option (e.g., `--ui-bundle-url=../docs-ui/build/ui-bundle.zip`).
201+
You can point Antora at this bundle using the `--ui-bundle-url` command-line option (e.g., `--ui-bundle-url=../docs-ui-sandbox/build/ui-bundle.zip`).
202202

203203
== Control the Visual Appearance of Pages
204204

@@ -437,12 +437,12 @@ Releasing the UI bundle consists of the following tasks:
437437
Fortunately, you don't have to do any of these steps yourself.
438438
These steps are fully automated by the `gulp release` task.
439439
In fact, you don't even have to run the `gulp release` task manually.
440-
When a commit is pushed to the master branch of the repository, it triggers the CI job named *release-docs-ui-bundle*, which executes the `gulp release` task using pre-configured credentials.
440+
When a commit is pushed to the master branch of the repository, it triggers the CI job named *docs-ui-sandbox*, which executes the `gulp release` task using pre-configured credentials.
441441

442442
IMPORTANT: A release will only be made if the project validates.
443443
To validate the project, run `gulp pack` before pushing your changes to GitHub.
444444

445-
The release-docs-ui-bundle CI job is already configured, so there's nothing you need to do to make automated release work.
445+
The docs-ui-sandbox CI job is already configured, so there's nothing you need to do to make automated release work.
446446
All you have to do is commit your changes and push those commits to the master branch of the git repository.
447447
A few seconds later, a new bundle will be available for use with Antora.
448448
Run `git pull` to retrieve the updated README that includes the new URL.
@@ -475,7 +475,7 @@ In the CI job configuration, covered in the next section, you'll learn how this
475475
=== CI Job Configuration
476476

477477
Jenkins is used to execute the CI job that publishes the UI bundle.
478-
The job is named *release-docs-ui-bundle* and can be found under the *Antora* folder in the Jenkins server managed by the Couchbase docs team.
478+
The job is named *docs-ui-sandbox* and can be found under the *Antora* folder in the Jenkins server managed by the Couchbase docs team.
479479
This section describes in detail how that job has been configured in case it must be recreated.
480480

481481
The release is performed by the cb-docs-robot GitHub account, which interacts with GitHub entirely using the GitHub API.
@@ -484,10 +484,10 @@ The release script authenticates with the GitHub API as the cb-docs-robot user u
484484
Create a new CI job from the Pipeline project template.
485485
On the configuration screen, select or populate the following settings:
486486

487-
.Configuration details for the Antora/release-docs-ui-bundle CI job
487+
.Configuration details for the Antora/docs-ui-sandbox CI job
488488
====
489489
General::
490-
* _Project name:_ `release-docs-ui-bundle`
490+
* _Project name:_ `docs-ui-sandbox`
491491
* _Description:_ Packs, tags, and releases the UI bundle whenever a non-ignored commit is pushed to the master branch of this repository.
492492
* [x] GitHub project
493493
** _Project url:_ `pass:a[{url-project}]`

0 commit comments

Comments
 (0)