Documenting new guide setup for rollback pipeline #9617
Conversation
yaningo
changed the title
…p-a-rollback-pipeline
| . Review the generated YAML configuration template to ensure you understand the rollback pipeline. | ||
| . Select btn:[Commit Config] to create this rollback configuration template in your repository. The configuration will be committed to a new branch called `rollback-pipeline-setup` in your selected repository. | ||
| . Expand the **Add deploy markers to existing pipeline** section. | ||
| . In the **Environment Name** dropdown, select or type the xref:configure-deploy-markers#manage-environments[target environment]. |
There was a problem hiding this comment.
Add something here about what environments are - can you the same language as the tooltip in the app actually. Also mention if you don't have any set up yet adding one here will set up an environment of that name for you when a pipeline runs .... I think that's correct anyway
(Same feedback for numxt bullet point too)
|
|
||
| This config is a template rollback pipeline that includes the following: | ||
| . The setup will auto-generate deploy marker commands based on your selections. | ||
| . Copy the generated commands using the btn:[Copy] button and paste them into your existing config file where the deployment occurs. |
There was a problem hiding this comment.
I think make it clear they are going to need to break this snipp up so the plan happens before their actual deployment and the update after? @rafaelmtorres just wondering if it would make sense to have two snippets not one for this reason?
|
|
||
| === 6. Access rollback functionality | ||
| Once the pull request is merged, the rollback setup is complete. You can now use the rollback functionality in the CircleCI UI. | ||
| You can now use the rollback functionality in the CircleCI UI. |
There was a problem hiding this comment.
You can now rolback deployments by running a rollback pipeline
or something like that
because they can already use a workflow rollback without all this work
Description
Reasons
A new guided setup is now available to replace the previous manual setup process.
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):