Docs for Autodetected releases and release markers #9026
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit 2ff6300.
rosieyohannan
changed the title
alexazl
approved these changes
Oct 23, 2024
cperez08
reviewed
Oct 24, 2024
|
|
||
| === Autodetection of releases | ||
|
|
||
| CircleCI looks for the word `deploy` in your job names to detect when a release may be in progress and creates an autodetected release marker. |
There was a problem hiding this comment.
Suggested change
| CircleCI looks for the word `deploy` in your job names to detect when a release may be in progress and creates an autodetected release marker. | |
| CircleCI looks for the word `deploy` in your job names to detect when a release may have happened and creates an autodetected release marker. |
clarify the release might have been done for two reasons
- we decide to create the release when the deploy job is success, it means is in a terminal status (the thing already happened)
- we don't care much about the status of the release, we just log the event but the release may be in progress, success or failure status.
cperez08
reviewed
Oct 24, 2024
| When CircleCI creates a release marker for you automatically, we use the information available in your pipeline configuration to create the following: | ||
|
|
||
| * **Component**: CircelCI created a component for the release and uses your project name to create a component name. | ||
| * **Environment integration**: CircleCI creates an enviornment for you, using your job and workflow names to create a relevant name. The environment has the type `AUTODETECTED`. |
There was a problem hiding this comment.
should we mention that if we do a best effort to determine the environment name, if not possible the environment name would be autogenerated, also they can feel free to rename it and that won't cause any issues with the autodetection process
There was a problem hiding this comment.
Oh I see, so they can update the name, just not the type
There was a problem hiding this comment.
the team discarded the idea of updating the type for now, we are going to allow only the name from the time being
cperez08
approved these changes
Oct 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Expanded section in releases overview to explain the process of autodetection, how to opt out, how to go and manually configure an exisitng release marker or manually set up from scratch.
Reasons
A link to a GitHub and/or JIRA issue (if applicable).
Otherwise, a brief sentence about why you made these changes.
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) 😸: