Skip to content

Commit b04e819

Browse files
committed
fix linter errors
1 parent 4ecce48 commit b04e819

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

docs/guides/modules/ROOT/partials/pipelines-and-triggers/custom-webhook-setup.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
include::ROOT:partial$app-navigation/steps-to-project-settings.adoc[]
22
. Select **Project Setup** in the sidebar.
3-
. If there is already a GitHub App pipeline set up that you want to trigger with your custom webhook, proceed to the **Triggers** step below (step 5). If not, select btn:[Add Pipeline]. You can find guidance on setting up a pipeline in the xref:orchestrate:pipelines.adoc#add-or-edit-a-pipeline[Pipeleines overview and setup] page.
3+
. If there is already a GitHub App pipeline set up that you want to trigger with your custom webhook, proceed to the **Triggers** step below (step 5). If not, select btn:[Add Pipeline]. You can find guidance on setting up a pipeline in the xref:orchestrate:pipelines.adoc#add-or-edit-a-pipeline[Pipelines overview and setup] page.
44
+
5-
NOTE: If you have not yet installed the CircleCI GitHub App into your GitHub organization you will be prompted to do so at this point. Installing the GitHub App is a one-time step that can be done by an organization admin. Once installed, further GitHub App pipelines can be setup without this installation step. For a detailed guide to using both OAuth and GitHub App integrations, see the xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page. If you run into an issue when trying to install the CircleCI GitHub App (for example, the App looks installed on GitHub, but does not show up on CircleCI), please submit a request through link:https://forms.gle/aaVERZNNvzsDLJJ46[this form].
5+
NOTE: If you have not installed the CircleCI GitHub App into your GitHub organization you will be prompted to do so. Installing the GitHub App is a one-time step that can be done by an organization admin. Once installed, further GitHub App pipelines can be set up without this installation step. For a detailed guide to using both OAuth and GitHub App integrations, see the xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page. If you run into an issue when installing the CircleCI GitHub App (for example, the App looks installed on GitHub, but does not show up on CircleCI), submit a request through link:https://forms.gle/aaVERZNNvzsDLJJ46[this form].
66
. Select btn:[Custom webhook +] at the bottom of the pipeline box.
77
. Enter a descriptive name for the webhook event.
88
. Enter the name of the event source for the trigger. For example, if you are setting up a custom webhook to run pipelines on events from Datadog, enter "Datadog" here.

docs/guides/modules/ROOT/partials/troubleshoot/pipelines-troubleshoot-snip.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ config file .circleci/sample-filename.yml could not be located on branch sample-
1111
1212
* If there is a config file present:
1313
.. Navigate to menu:Project Settings[Pipelines] or menu:Project Settings[Project Setup] in the CircleCI web app for the project where you are seeing this error message.
14-
.. Ensure that the "Config File Path" field matches the filepath of the config file that is in your repository. If you changed the name of the config file in your repository, the reference to that filepath must also be changed for any pipeline that uses that configuration file.
14+
.. Ensure that the "Config File Path" field matches the file path of the config file that is in your repository. If you changed the name of the config file in your repository, the reference to that file path must also be changed for any pipeline that uses that configuration file.
1515
1616
[#why-is-my-scheduled-pipeline-not-running]
1717
=== Why is my scheduled pipeline not running?
@@ -44,7 +44,7 @@ In order to keep the system stable for all CircleCI customers, we implement diff
4444
[#find-project-projects-dashboard]
4545
=== Why can I not find my project on the Projects dashboard?
4646

47-
If you are not seeing a project you would like to build, and it is not currently building on CircleCI, check your org in the top left corner of the CircleCI application. For instance, if the top left shows your user `my-user`, only projects belonging to `my-user` will be available under *Projects*. If you want to build the project `your-org/project`, you must switch your organization on the application's organization switcher menu to `your-org`.
47+
If you do not see a project you would like to build, check your org in the top left corner of the CircleCI application. For instance, if the top left shows your user `my-user`, only projects belonging to `my-user` will be available under *Projects*. If you want to build the project `your-org/project`, you must switch your organization on the application's organization switcher menu to `your-org`.
4848

4949
[#how-do-docker-image-names-work]
5050
=== How do Docker image names work? Where do they come from?

docs/guides/modules/about-circleci/pages/introduction-to-the-circleci-web-app.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ The following settings are available in the project settings page. If you do not
155155

156156
**Project Setup**: Provides a list of GitHub pipelines that have been set up for the project and their associated triggers. See xref:orchestrate:pipelines.adoc[Pipelines Overview and Setup] for more information. Pipelines integrated with VCS different from GitHub are shown in the **Pipelines** tab. This page includes the option to create a first pipeline if none exist. The setup UI for scheduled pipelines is located here for GitHub pipelines or in the *Triggers* section for Bitbucket pipelines. To set up a xref:orchestrate:scheduled-pipelines.adoc[scheduled pipeline] you will define a timetable, parameter, and attribution to automatically run a pipeline when the criteria is met.
157157

158-
*Pipelines* and *Triggers*: These pages let you set up pipelines and triggers when using the Gitlab, Bitbucket Cloud and Bitbucket Data Center integrations.
158+
*Pipelines* and *Triggers*: These pages let you set up pipelines and triggers when using the GitLab, Bitbucket Cloud and Bitbucket Data Center integrations.
159159

160160
**Deploys**: A UI for managing and viewing deployments. Setup and manage environment integrations, setup components. For full information on the deploys feature, start with the xref:deploy:deployment-overview.adoc[Deployment overview] page.
161161

docs/guides/modules/orchestrate/pages/pipelines.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,13 @@ include::guides:ROOT:partial$app-navigation/steps-to-project-settings.adoc[]
7272
. Select *Project Setup* in the sidebar.
7373
. Select btn:[Add Pipeline], or, if you wish to edit an existing pipeline select the pencil icon (image:guides:ROOT:icons/edit-solid.svg[edit icon, role="no-border"]) to the right of the section you want to change.
7474
+
75-
NOTE: If you have not yet installed the CircleCI GitHub App into your GitHub organization you will be prompted to do so at this point. Installing the GitHub App is a one-time step that can be done by an organization admin or a user who has admin access to at least one repository in the organization. Once installed, further GitHub App pipelines can be setup without this installation step. For a detailed guide to using both OAuth and GitHub App integrations, see the xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page.
75+
NOTE: If you have not yet installed the CircleCI GitHub App into your GitHub organization you will be prompted to do so at this point. Installing the GitHub App is a one-time step that can be done by an organization admin. Once installed, further GitHub App pipelines can be setup without this installation step. For a detailed guide to using both OAuth and GitHub App integrations, see the xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page.
7676
. Complete the form fields and options:
7777
** Give your pipeline a descriptive name, for example `Run tests and deploy`.
7878
** Authorize your connection if this is not already showing with a check mark image:guides:ROOT:icons/passed.svg[passed icon, role="no-border"]. #Can we remove this step? I think this is in the top bar of the app now?#
7979
** Select a repository to be your config source.
8080
** Enter your config file path. The field is automatically populated with the default path `.circleci/config.yml` but you can edit this if needed.
81-
** Select a checkout source for this pipeline. This is the repository that will be checked out when a xref:reference:ROOT:configuration-reference.adoc#checkout[checkout step] is run. If your config is stored in the same repository as your code, pick the same repository you selected for the config source.
81+
** Select a checkout source for this pipeline. This repository will be checked out when a xref:reference:ROOT:configuration-reference.adoc#checkout[checkout step] is run. If your config is stored in the same repository as your code, pick the same repository you selected for the config source.
8282
. Select btn:[Save].
8383
8484
Once you have set up a pipeline you need to set up a trigger to connect it to. Setting up a trigger is covering in the xref:set-up-triggers.adoc[Set up triggers] page.

docs/guides/modules/orchestrate/pages/set-up-multiple-configuration-files-for-a-project.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ include::ROOT:partial$app-navigation/steps-to-project-settings.adoc[]
4949
+
5050
. Select btn:[Add Pipeline].
5151
+
52-
NOTE: If you have not yet installed the CircleCI GitHub App into your GitHub organization you will be prompted to do so at this point. Installing the GitHub App is a one-time step that can be done by an organization admin . Once installed, further GitHub App pipelines can be setup without this installation step. For a detailed guide to using both OAuth and GitHub App integrations, see the xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page. If you run into an issue when trying to install the CircleCI GitHub App (for example, the App looks installed on GitHub, but doesn't show up on CircleCI), submit a request through link:https://forms.gle/aaVERZNNvzsDLJJ46[this form].
52+
NOTE: If you have not installed the CircleCI GitHub App into your GitHub organization you will be prompted to do so. Installing the GitHub App is a one-time step that can be done by an organization admin. Once installed, further GitHub App pipelines can be setup without this installation step. For a guide to using both OAuth and GitHub App integrations, see the xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page. If you run into an issue when installing the CircleCI GitHub App (for example, App looks installed on GitHub, but does not show up on CircleCI), submit a request through link:https://forms.gle/aaVERZNNvzsDLJJ46[this form].
5353
. Complete the required form fields:
5454
** Give your pipeline a descriptive name.
5555
** Under *Config Source* select the repository where the config file is stored. This can be the same repository as your code or a different repository.

docs/guides/modules/orchestrate/pages/triggers-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ For more information on using custom and outbound webhooks, see the xref:custom-
146146
****
147147
When handling custom webhook requests, we use the "config branch" and "checkout branch" fields (`config_ref` and `checkout_ref` in the API) to determine which commits should be used for config and code checkout. This information is retrieved from link:https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#get-a-commit[GitHub's API].
148148
149-
Since GitHub does not provide documented consistency guarantees for their API responses, there can be a brief delay (typically seconds) between when a commit is pushed and when the API returns the updated reference, especially with larger repositories. As a result, when fetching a branch reference, you may receive a slightly outdated commit rather than the most recent one.
149+
GitHub does not provide documented consistency guarantees for their API responses. There can be a brief delay (typically seconds) between when a commit is pushed and when the API returns the updated reference, especially with larger repositories. As a result, when fetching a branch reference, you may receive a slightly outdated commit rather than the most recent one.
150150
****
151151

152152
[#trigger-a-pipeline-from-vs-code-with-unversioned-config]

0 commit comments

Comments
 (0)