Skip to content

Add documentation about the project slug #9337

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation about the project slug #9337

wants to merge 1 commit into from

Conversation

stig
Copy link
Contributor

@stig stig commented Apr 10, 2025

Description

Add documentation about the existing pipeline.project.slug pipeline value.

Reasons

We refer to this elsewhere in documentation, cf snippets/orchestration-examples/serial-group.yml#L10. It makes sense to document it in this list of pipeline values.

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.

We refer to this elsewhere in documentation, cf
snippets/orchestration-examples/serial-group.yml#L10. It makes sense
to document it in this list of pipeline values.
@stig stig requested review from a team as code owners April 10, 2025 11:30
@stig stig requested a review from a team April 11, 2025 09:36
@BeFunes
Copy link
Contributor

BeFunes commented Apr 15, 2025

🔴 Please don't merge this. The content of this pipeline value is incorrect for GitHub App pipelines triggered by GitHub OAuth organizations.
Needs https://circleci.atlassian.net/browse/SC-1904

@stig
Copy link
Contributor Author

stig commented Apr 16, 2025

🔴 Please don't merge this. The content of this pipeline value is incorrect for GitHub App pipelines triggered by GitHub OAuth organizations. Needs circleci.atlassian.net/browse/SC-1904

Please use the "require change" option on review in this case, so nobody accidentally merges it given the positive review.

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