-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update GitHub App integration overview #9208
Conversation
@@ -52,7 +53,7 @@ When you choose btn:[Commit and Run], as described above, a pipeline is triggere | |||
|
|||
If you choose to review the configuration file in the config editor first, the pipeline is triggered after you save the `.circleci/config.yml` by clicking the btn:[Commit and Run] button. | |||
|
|||
Each time you push changes to your GitHub repository, a new pipeline is triggered. You will see the pipeline running in the CircleCI web app. | |||
Upon xref:github-app-trigger-options/#supported-trigger-events[the event you selected under the "Run on" menu], a new pipeline is triggered. You will see the pipeline running in the CircleCI web app. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Upon xref:github-app-trigger-options/#supported-trigger-events[the event you selected under the "Run on" menu], a new pipeline is triggered. You will see the pipeline running in the CircleCI web app. | |
Upon xref:github-app-trigger-options/#supported-trigger-options[the event you selected under the "Run on" menu], a new pipeline is triggered. You will see the pipeline running in the CircleCI web app. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry I changed the tag
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
[#only-build-pull-requests] | ||
=== Only build pull requests | ||
|
||
Select the appropriate xref:github-app-trigger-options/#supported-trigger-events[option under the "Run on" menu] in your trigger settings. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe state it's "PR opened or pushed to, default branch pushes, tag pushes"?
[#only-build-pull-requests] | ||
=== Only build pull requests | ||
|
||
In your trigger settings, select the `PR opened or pushed to, default branch pushes, tag pushes` xref:github-app-trigger-options/#supported-trigger-options[option under the "Run on" menu]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In your trigger settings, select the `PR opened or pushed to, default branch pushes, tag pushes` xref:github-app-trigger-options/#supported-trigger-options[option under the "Run on" menu]. | |
In your trigger settings, select the "PR opened or pushed to, default branch pushes, tag pushes" option under the "Run on" menu. For a full list of GitHub App trigger options, see the xref:github-app-trigger-options/#supported-trigger-options[GitHub App trigger options] page. | |
image::triggers/run-on-open.png[Run on trigger menu options] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't always follow this rule but we should generally not just link to other sections from text, the link text generally should tell you exactly what you will find when you click the link. Does that make sense?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -52,7 +53,7 @@ When you choose btn:[Commit and Run], as described above, a pipeline is triggere | |||
|
|||
If you choose to review the configuration file in the config editor first, the pipeline is triggered after you save the `.circleci/config.yml` by clicking the btn:[Commit and Run] button. | |||
|
|||
Each time you push changes to your GitHub repository, a new pipeline is triggered. You will see the pipeline running in the CircleCI web app. | |||
Upon xref:github-app-trigger-options/#supported-trigger-options[the event you selected under the "Run on" menu], a new pipeline is triggered. You will see the pipeline running in the CircleCI web app. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
THis whole Trigger a pipeline in CircleCI section seems wrong now, for example "When you choose btn:[Commit and Run], as described above" ... I don't think we do describe it above anymore, could you check and see what you think? The section can probably be simplified with a link to how to trigger or something, or be condensed into the section above.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a line in the "When you create a new organization, you will be guided to start creating projects, as follows:" bullet point list to mention the "new" Commit config and run
button
Description
Adding content to document new trigger options for GitHub App integrated projects.
Reasons
In the additional "Run on" menu in the trigger settings, GitHub App users can now select which event will trigger the pipeline.
Content Checklist
Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.
Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs) 😸: