Skip to content

Commit a109b56

Browse files
committed
fix more lint errors
1 parent 2e4636c commit a109b56

File tree

3 files changed

+18
-13
lines changed

3 files changed

+18
-13
lines changed

docs/guides/modules/integration/pages/gitlab-integration.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This page walks you through integrating a GitLab project with CircleCI. The sect
88
[#overview]
99
== What is GitLab CI/CD?
1010

11-
GitLab CI/CD allows you to build, test (continuous integration) and deploy (continuous deployment, continuous delivery) your projects each time a developer pushes a change to the codebase, and/or when a merge request is created. As an alternative, you can integrate with CircleCI to manage your CI/CD pipelines. If you use GitLab (SaaS or Self-managed) for version control and code storage, GitLab CI/CD is enabled for your project by default.
11+
GitLab CI/CD allows you to build, test and deploy your projects each time a developer pushes a change to the codebase, and/or when a merge request is created. As an alternative, you can integrate with CircleCI to manage your CI/CD pipelines. If you use GitLab (SaaS or Self-managed) for version control and code storage, GitLab CI/CD is enabled for your project by default.
1212

1313
Integrate with CircleCI to access features for automated software delivery:
1414

@@ -51,7 +51,7 @@ You can choose a sample `.circleci/config.yml` to best fit your project from a v
5151
5252
The first two options (**Fastest** and **Faster**) automatically trigger a pipeline once you create the project.
5353
--
54-
GitLab Self-Managed::
54+
GitLab self-managed::
5555
+
5656
--
5757
NOTE: **Remove GitLab CI/CD config** You should remove the `.gitlab-ci.yml` file from projects you integrate with CircleCI. This prevents you from having CI/CD builds happening in both systems. There is an option to _disable_ GitLab CI/CD for a project in the GitLab UI but using this is **not recommended**.
@@ -92,13 +92,13 @@ image::guides:ROOT:gl-sm-create-project.png[Create a new project in a self-manag
9292
9393
. Copy and paste the SSH host key from your self-managed instance into **known_hosts**. Select **Connect**.
9494
+
95-
NOTE: If you are using both CircleCI's Bitbucket Data Center and GitLab Self-Managed integrations, there is a known bug in the menu:Organization Settings[Integrations] section of the CircleCI web app. Adding a `known_hosts` to one integration will populate the `known_hosts` for the other integration. To use both Bitbucket Data Center and GitLab Self-Managed integrations within the same CircleCI organization, add both respective `known_hosts` values to the one input field separated by a new line.
95+
NOTE: If you are using both CircleCI's Bitbucket Data Center and GitLab self-managed integrations, there is a known bug in the menu:Organization Settings[Integrations] section of the CircleCI web app. Adding a `known_hosts` to one integration will populate the `known_hosts` for the other integration. To use both Bitbucket Data Center and GitLab self-managed integrations within the same CircleCI organization, add both respective `known_hosts` values to the one input field separated by a new line.
9696
9797
. Once your account is successfully authorized, select the repository for your CircleCI project, and enter a project name.
9898
9999
. Finally, select **Create Project**. You will then be redirected to the newly-created project's Pipelines page.
100100
101-
The express CircleCI configuration setup is not currently available for GitLab Self-managed projects. You will need to add a `.circleci/config.yml` file in your repository if it has not yet been set up. If the repository you selected already contains a `.circleci/config.yml`, you will need to save a commit in the repository to see your pipeline on the dashboard.
101+
The express CircleCI configuration setup is not currently available for GitLab self-managed projects. You will need to add a `.circleci/config.yml` file in your repository if it has not yet been set up. If the repository you selected already contains a `.circleci/config.yml`, you will need to save a commit in the repository to see your pipeline on the dashboard.
102102
--
103103
====
104104

@@ -127,7 +127,7 @@ When you create a new project using the **Fastest** (use an existing `config.yml
127127
128128
If you use the **Fast** config setup, the pipeline is not triggered until you save the `.circleci/config.yml` by clicking the **Commit and Run** button in the web app.
129129
--
130-
GitLab Self-Managed::
130+
GitLab self-managed::
131131
+
132132
--
133133
If you have not already done so, add a `.circleci` directory to the root of the repository, then add a `config.yml` file in that directory.
@@ -226,7 +226,7 @@ Add or remove users, and manage user roles for the organization as well as user
226226
[#organization-settings-integrations]
227227
=== Integrations (GitLab self-managed only)
228228

229-
For GitLab Self-managed organizations, you may connect additional self-managed instances to be integrated with your organization.
229+
For GitLab self-managed organizations, you may connect additional self-managed instances to be integrated with your organization.
230230

231231
. Navigate to **Integrations** within **Organization Settings** to add a new instance.
232232
+
@@ -241,7 +241,7 @@ For GitLab.com, account integrations can be managed under your xref:#user-accoun
241241
[#establish the authenticity of an SSH host]
242242
==== Establish the authenticity of an SSH host
243243

244-
For GitLab self-managed instances, it is necessary to add the SSH host keys to a "known hosts" file (`~/.ssh/known_hosts`) so that CircleCI can verify that the host it is connecting to is authentic. The **known_hosts** input stores your instance's public host keys so CircleCI jobs can verify the remote host's identity when checking out code.
244+
For GitLab self-managed instances, you need to add the SSH host keys to a "known hosts" file (`~/.ssh/known_hosts`). This enables CircleCI to verify that the host it is connecting to is authentic. The **known_hosts** input stores your instance's public host keys so CircleCI jobs can verify the remote host's identity when checking out code.
245245

246246
SSH keys for remote servers can be fetched by running `ssh-keyscan <host>`, for example, `ssh-keyscan test-gitlab.circleci.com`.
247247

docs/guides/modules/orchestrate/pages/github-trigger-event-options.adoc

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ When you create or set up a project in CircleCI you will set up your first pipel
2323

2424
include::ROOT:partial$tips/check-github-type-org.adoc[]
2525

26-
If your CircleCI organization is integrated with GitHub only through the **GitHub App** (see tip above), you will see trigger options when creating a project in the CircleCI web app, and you have the option to change the trigger options for your first trigger. You can also set up additional triggers during project creation, or setup/edit later in your menu:Project settings[Project Setup].
26+
If your CircleCI organization is integrated with GitHub only through the **GitHub App**, you will see trigger options when creating a project in the CircleCI web app. You have the option to change the trigger options for your first trigger when setting the project up. You can also set up additional triggers during project creation, or setup/edit later in your menu:Project settings[Project Setup].
2727

2828
.Trigger options during project creation
2929
image::guides:ROOT:triggers/create-project-run-on.png[Create a project trigger and access trigger options]
@@ -95,7 +95,7 @@ All pipelines triggered by link:https://docs.github.com/en/webhooks/webhook-even
9595
* `pipeline.event.github.pull_request.head.ref`: the name of the *head* branch of the PR - that is the branch containing the changes to be merged.
9696
* `pipeline.event.github.pull_request.draft`: a boolean value indicating whether the pull request is a draft.
9797
+
98-
**Usage example**: To trigger a pipeline on _PR opened or pushed to, default branch and tag pushes_, but ensure that it never runs if the event is associated with a PR that is marked as draft, use the following filter.
98+
**Example**: To trigger a pipeline on `PR opened or pushed to, default branch and tag pushes`, and ensure that it never runs if the event is associated with a draft PR, use the following:
9999
+
100100
[,yaml]
101101
----
@@ -113,7 +113,7 @@ workflows:
113113

114114
* `pipeline.event.github.pull_request.title`: the title of the pull request.
115115
* `pipeline.event.github.pull_request.number`: the numeric identifier of the pull request.
116-
* `pipeline.event.github.pull_request.merged`: a boolean that indicates whether the PR was merged or not.
116+
* `pipeline.event.github.pull_request.merged`: a boolean that indicates whether the PR was merged or not.
117117

118118
These values are extracted directly from the GitHub event payload. The part after prefix `pipeline.event.github.*` matches the corresponding field in the pull request event structure described in link:https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request[the GitHub docs].
119119

@@ -142,7 +142,7 @@ include::guides:ROOT:partial$app-navigation/steps-to-project-settings.adoc[]
142142
.Trigger options under Project settings
143143
image::guides:ROOT:triggers/select-when-to-run.png[Set a trigger option for a project trigger]
144144
.
145-
** Select the *Event Source* repository from the dropdown. This defaults to the config source repository. If you change it to a repository that does not match the pipeline's config or checkout source, you will be prompted to specify a fixed branch to be used respectively for fetching config and checking out code.
145+
** Select the *Event Source* repository from the dropdown. This defaults to the config source repository. If you change it to a repository that does not match the pipeline's checkout source, you can specify a branch to be used for fetching config and code checkout.
146146
. Select btn:[Save].
147147

148148
To verify your trigger is set up correctly, trigger an event (open a PR) from your repository.
@@ -153,7 +153,12 @@ To verify your trigger is set up correctly, trigger an event (open a PR) from yo
153153

154154
No, different trigger event options cannot be combined in a single trigger. However, you can create multiple triggers for the same pipeline that listen for events from the same repository, with each trigger using a different trigger event option.
155155

156-
For example, by having one trigger with the trigger option "PR opened" and a second trigger with the trigger option "PR merged", your pipeline will trigger whenever a PR is opened or merged.
156+
For example, by having the following:
157+
158+
* One trigger with the trigger option "PR opened"
159+
* One trigger with the trigger option "PR merged"
160+
161+
Your pipeline will trigger whenever a PR is opened or merged.
157162

158163
== Next steps
159164

docs/guides/modules/orchestrate/pages/set-up-triggers.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ NOTE: **Using CircleCI server?** The Pipeline and Trigger pages under Project Se
1717

1818
The pipeline and trigger options and features available to you depend on how your code is integrated and where it is stored. For a feature availability overview, see the xref:integration:version-control-system-integration-overview.adoc[VCS integration overview] page.
1919

20-
There are broadly three types of triggers:
20+
Triggers are available in the following types:
2121

2222
* VCS triggers.
2323
* Custom webhooks used for triggering pipelines from external services.

0 commit comments

Comments
 (0)