Skip to content
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

Merged
merged 8 commits into from
Oct 14, 2024

Conversation

BeFunes
Copy link
Contributor

@BeFunes BeFunes commented Oct 9, 2024

Description

I've edited the section Trigger a pipeline using the API to:

  • Updated the TIP section about lack of support for BBDC, Github App & Gitlab to only mention Gitlab
  • Added a section about how to trigger a Github App / BBDC pipeline via API, including a CURL command

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) 😸:

  • Break up walls of text by adding paragraph breaks.
  • Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
  • Keep the title between 20 and 70 characters.
  • Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • Check all headings h1-h6 are in sentence case (only first letter is capitalized).
  • Is there a "Next steps" section at the end of the page giving the reader a clear path to what to read next?
  • Include relevant backlinks to other CircleCI docs/pages.

@BeFunes BeFunes requested review from a team as code owners October 9, 2024 13:47

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.
Copy link
Contributor

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Of course! Thank you

@BeFunes BeFunes merged commit 72157b0 into master Oct 14, 2024
3 checks passed
@rosieyohannan rosieyohannan deleted the Benny/update-API-trigger-docs branch November 20, 2024 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants