Commit 61d9dea3 authored by Denis Konovalyenko's avatar Denis Konovalyenko

CI documentation improved [skip ci].

parent 4281f2a9
# The jobs of one stage are going to be run simultaneously.
# The verification stage jobs:
# - verification
# The deployment stage jobs:
# - snapshot
# - release
# The status stage jobs:
# - success
# - snapshot-success
# - failure
# On pushing to the code repository the "verification" job is run.
# If during any job run, except the "snapshot-success" and "success" ones,
# a failure occurs, the "failure" job is run.
# If a branch is a "snapshot branch", then the "snapshot" job is run.
# If a branch is a "tag", then the "release" job is run.
# If the "snapshot" job run succeeded, the "success" and "snapshot-success"
# jobs are run.
# If the "verification" job run succeeded and there is no "snapshot" or
# "release" job for this pipeline, the "success" job is run.
- verification
- deployment
......@@ -11,6 +39,7 @@ variables:
# OPENSSL_CLI_OPTS: "enc aes-256-cbc -K ${OPENSSL_ENC_KEY} -iv ${OPENSSL_ENC_IV}"
GPG_CONF: ".gnupg/gpg.conf"
GPG_AGENT_CONF: ".gnupg/gpg-agent.conf"
# TODO: adjust the line below to refer to the appropriate Okapi project ID.
# TODO: Replace 2 lines below with appropriate ("dev") values when everything is get ready.
OKAPI_SNAPSHOTS_BRANCH: "gitlab-integration"
# Overview
By adding a `.gitlab-ci.yml` file to the root directory of the source
repository and configuring the GitLab project to use
[a Runner]( you are
activating [GitLab's continuous integration service](,
which in its turn will give you an ability to automatically trigger
your CI [pipeline]( for
each push to the repository. For more general information please refer
to [the getting started guide](
# Bitbucket integration
GitLab CI/CD can be used with GitHub or any other Git server. Instead
of moving the entire project to GitLab, we will connect our Butbucket
repository to get the benefits of GitLab CI/CD. That will set up
repository mirroring and create a lightweight project where issues,
merge requests, wiki, and snippets disabled (these features can be
re-enabled later).
Below are the steps required to be taken.
1. In GitLab create a **CI/CD for external repo**, select **Repo by URL**
and create the project. GitLab will import the repository and enable
Pull Mirroring.
2. In GitLab create a [Personal Access Token](
with api scope. This will be used to authenticate requests from the web
hook that will be created in Bitbucket to notify GitLab of new commits.
3. In Bitbucket from **Settings > Webhooks** create a new web hook to
notify GitLab of new commits.
The web hook URL should be set to the GitLab API to trigger pull
mirroring, using the Personal Access Token, which has been just
generated for the authentication. The web hook Trigger should be set
to ‘Repository Push’.
`PERSONAL_ACCESS_TOKEN`: the generated personal access token
`CI_PROJECT_ID`: the GitLab project ID, it can be found on the
landing page of the project
4. In Bitbucket create an **App Password** from Bitbucket **Settings >
App Passwords** to authenticate the build status script setting commit
build statuses in Bitbucket. Repository write permissions are required.
5. In GitLab from **Settings > CI/CD > Variables** add variables to
allow communication with Bitbucket via the Bitbucket API.
`BITBUCKET_ACCESS_TOKEN`: the Bitbucket app password created above
`BITBUCKET_USERNAME`: the username of the Bitbucket account
`BITBUCKET_NAMESPACE`: set this if your GitLab and Bitbucket
namespaces differ
`BITBUCKET_REPOSITORY`: set this if your GitLab and Bitbucket
project names differ
The required `build-status` script can be found under `ci/gitlab` path.
GitLab should now be configured to mirror changes from Bitbucket,
run CI/CD pipelines configured in `.gitlab-ci.yml` and push the status
to Bitbucket.
For extra details please refer to [the original GitLab guide]( .
# Triggering the Okapi project pipeline
When you get done with the Bitbucket integration, make sure the
following variables are declared:
`OKAPI_TRIGGER_TOKEN`: the trigger token which has to be added to the
Okapi project before that (needs to be added under
**Settings > CI/CD > Variables**)
`OKAPI_SNAPSHOTS_BRANCH`: the snapshots branch of Okapi project
`OKAPI_PROJECT_ID`: the Okapi project ID in GitLab, it can be found on
the landing page of the Okapi project
So, the following line from the `.gitlab-ci.yml` can be executed successfully:
# Sonatype integration
The following secret variables have to be declared under
**Settings > CI/CD > Variables**:
`MAVEN_REPO_USER`: sonatype user
`MAVEN_REPO_PASS`: sonatype user's password
`GPG_KEY`: the key for code signing (base64-encoded)
`GPG_PASSPHRASE`: the pass-phrase for the code signing key
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