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

PIPE-4728 Add is default branch pipeline value #8901

Merged
merged 1 commit into from
Aug 12, 2024

Conversation

liamclarkedev
Copy link
Contributor

Description

A new pipeline value that represents whether the branch the pipeline was triggered on is the default, following the below criteria:

  • true when it is the default branch.
  • false when it isn’t the default branch.
  • false when it is any other push (e.g. tag push).
  • omitted when it is not a VCS-triggered pipeline.

Reasons

A link to a GitHub and/or JIRA issue (if applicable).
Otherwise, a brief sentence about why you made these changes.

https://circleci.atlassian.net/browse/PIPE-4728

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.

@liamclarkedev liamclarkedev requested review from a team as code owners August 8, 2024 15:52
@liamclarkedev liamclarkedev force-pushed the pipe-4728/is-default-branch branch 2 times, most recently from 4a98a1b to 7de9720 Compare August 12, 2024 12:15
Copy link
Contributor

@rosieyohannan rosieyohannan left a comment

Choose a reason for hiding this comment

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

🎉 thank you!

A new pipeline value that represents whether the branch the pipeline
was triggered on is the default, following the below criteria:

- `true` when it is the default branch.
- `false` when it isn’t the default branch.
- `false` when it is any other push (e.g. tag push).
- omitted when it is not a VCS-triggered pipeline.

This pipeline value is available to Cloud pipelines triggered after
31st July 2024 and Server 4.6+.
@liamclarkedev liamclarkedev force-pushed the pipe-4728/is-default-branch branch from 7de9720 to f6a4cd4 Compare August 12, 2024 13:41
@liamclarkedev liamclarkedev merged commit 3013162 into master Aug 12, 2024
3 checks passed
@liamclarkedev liamclarkedev deleted the pipe-4728/is-default-branch branch August 12, 2024 13:44
liamclarkedev added a commit that referenced this pull request Aug 13, 2024
The version this is available for Server customers is 4.7 and above,
this fixes the incorrect version number from #8901.
rosieyohannan pushed a commit that referenced this pull request Aug 13, 2024
The version this is available for Server customers is 4.7 and above,
this fixes the incorrect version number from #8901.
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.

2 participants