[REL-4300] Adding docs for deploy pipeline #9821
Merged
Conversation
This file contains hidden or 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
504e5ec to
9c6aa40
Compare
avalcepina
commented
Dec 10, 2025
| . Select btn:[Deploy]. This opens the deploy execution modal. | ||
| + | ||
| .Deploy execution modal | ||
| image::guides:ROOT:deploy/rollback-execution-modal.png[Deploy execution modal] |
Contributor
Author
There was a problem hiding this comment.
Should be updated with the correct screenshot for deploys.
avalcepina
commented
Dec 10, 2025
| . Select btn:[Setup deploy pipeline] to activate the deploy pipeline. | ||
| + | ||
| .Setup deploy pipeline button | ||
| image::guides:ROOT:deploy/setup-rollback-pipeline-button.png[Setup deploy pipeline button] |
Contributor
Author
There was a problem hiding this comment.
Should be updated with the correct screenshot for deploys.
avalcepina
commented
Dec 10, 2025
| . You can manually navigate to the pull request by selecting btn:[View pull Request]. | ||
| + | ||
| .View pull request button | ||
| image::guides:ROOT:deploy/view-pr-button.png[View pull request button] |
Contributor
Author
There was a problem hiding this comment.
Should be updated with the correct screenshot for deploys.
avalcepina
commented
Dec 10, 2025
| . Alternatively, you can copy the suggested configuration into an existing or newly created deploy config file. Make sure the file is called `deploy.yml` and is located in the `.circleci` folder, for the system to detect and use this file. In this case, select btn:[I already have a deploy config] and skip to the next step. See the <<configuration-tips, Configuration tips>> section for more details on customizing your deploy configuration. | ||
| + | ||
| .Already have config button | ||
| image::guides:ROOT:deploy/already-have-config-button.png[Already have config button] |
Contributor
Author
There was a problem hiding this comment.
Should be updated with the correct screenshot for deploys.
avalcepina
commented
Dec 10, 2025
| NOTE: The configuration will be committed to a new branch called `deploy-pipeline-setup` in the repository you selected. | ||
| + | ||
| .Commit config button | ||
| image::guides:ROOT:deploy/commit-config-button.png[Commit config button] |
Contributor
Author
There was a problem hiding this comment.
Should be updated with the correct screenshot for deploys.
avalcepina
commented
Dec 10, 2025
| . Select the repository you want to deploy from the "What repo are you deploying?" dropdown. | ||
| + | ||
| .Select repository | ||
| image::guides:ROOT:deploy/select-deploy-repo.png[Select repository] |
Contributor
Author
There was a problem hiding this comment.
Should be updated with the correct screenshot for deploys.
avalcepina
commented
Dec 10, 2025
| . Once you have updated your config file, select btn:[I've updated my config] to proceed to the next step. | ||
| + | ||
| .Copy markers commands | ||
| image::guides:ROOT:deploy/config-updated-button.png[Copy markers commands] |
Contributor
Author
There was a problem hiding this comment.
Should be updated with the correct screenshot for deploys.
avalcepina
commented
Dec 10, 2025
| . Copy the generated commands using the btn:[Copy] button and paste them into your existing config file where the deployment occurs. Ensure the `circleci run release plan` step comes before the deployment step, followed by the `circleci run release update` step. | ||
| + | ||
| .Generated markers commands | ||
| image::guides:ROOT:deploy/auto-generated-commands.png[Generated markers commands] |
Contributor
Author
There was a problem hiding this comment.
Should be updated with the correct screenshot for deploys.
avalcepina
commented
Dec 10, 2025
| - If the GitHub App is not installed in your organization, the guided setup process prompts you to install it. | ||
| + | ||
| .Install GitHub App | ||
| image::guides:ROOT:deploy/install-github-app.png[Install GitHub App] |
Contributor
Author
There was a problem hiding this comment.
Should be updated with the correct screenshot for deploys.
avalcepina
commented
Dec 10, 2025
| . Select the btn:[Deploy] button in the project Overview. | ||
| + | ||
| .Deploy button on project overview page | ||
| image::guides:ROOT:deploy/project-overview-rollback.png[Deploy button on project overview page] |
Contributor
Author
There was a problem hiding this comment.
Should be updated with the correct screenshot for deploys.
rosieyohannan
approved these changes
Jan 8, 2026
103c37a
into
DOCSS-1818-deploys-diagram
2 of 3 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Note
You may find that there are errors for the
vale/lintjob that are unrelated to your change.Vale checks the whole file when a change is made so if there are existing issues on the page they will be flagged.
You can ignore lint errors outside your changes and the CircleCI docs team will address them for you.
Vale logs are advisory to help all contributors create content that conforms to our style guide. The
vale/lintjob will not prevent changes from being published.Description
Reasons
This goes along with the new feature we want to release.
Content checks
Please follow our style when contributing to CircleCI docs. View our style guide or check out our CONTRIBUTING.md for more information.
Preview your changes:
ci/circleci: lintjob at the bottom of your PR. You will be redirected to thevale/lintjob output in CircleCI.ci/circleci: buildjob at the bottom of your PR and you will be redirected to CircleCI. Select the Artifacts tab and selectindex.htmlto open a preview version of the docs site built for your latest commit.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):
Content structure:
Formatting: