-
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
Add instructions to run a Github App pipeline via API #9008
Conversation
jekyll/_cci2/triggers-overview.adoc
Outdated
|
||
NOTE: This endpoint is currently in preview, and is not yet documented in the link:https://circleci.com/docs/api/v2/index.html[official API V2 documentation]. | ||
|
||
. If you have not already, get set up to use API v2 by following the steps in the <<api-developers-guide#authentication-and-authorization,API Developers Guide>>. Here you will find instructions on how to find your project slug. |
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 think it would be better to explain project-slug here rather than leaving people to find it on the other page, is that ok if I add that?
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.
Of course! Thank you
Description
I've edited the section Trigger a pipeline using the API to:
I've not been able to preview these changes
Reasons
We are introducing support for triggering pipelines via API for Github App and BBDC pipelines.
This is supported by a new endpoint, different from the one used by classic projects.
In ~1 week, this new endpoint will also be usable for running classic pipelines. Once that's shipped, documentation will go live on https://circleci.com/docs/api/v2/index.html.
@BeFunes will sync with @rosieyohannan to update documentation once this goes live.
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) 😸: