diff --git a/runbooks/README.md b/runbooks/README.md index 88b1395881342dcc0de6ff423740a1a8c63bd68b..9d1337e298be849a66fba61bfc04fe768990b913 100644 --- a/runbooks/README.md +++ b/runbooks/README.md @@ -14,7 +14,7 @@ - [How to speed up the auto-deploy process for urgent merge requests?](how_to_speed_up_auto_deploy_process_for_urgent_merge_requests.md) - [Incident](incident.md) - [Increase disk size](increase-disk-size.md) -- [Merging with a red pipeline.](merging-with-a-red-pipeline.md) +- [Merging with a red pipeline](merging-with-a-red-pipeline.md) - [`PipelineNotFoundError` when publishing a package](pipeline-not-found-when-publishing.md) - [Run Post Deployment Migrations (PDM)](post-deployment-migrations.md) - [Auto-deploy - How to force start a new deployment pipeline for a package](re-deploy-auto-deploy-package.md) @@ -31,4 +31,4 @@ - [Overview of the releases.yml file](updating-releases.md) - [Deployer CI variables](variables.md) -This file is generated by generated-toc-file.sh. Check its [README here](https://gitlab.com/gitlab-org/release/docs/-/blob/master/scripts/README.md?ref_type=heads). \ No newline at end of file +This file is generated by generated-toc-file.sh. Check its [README here](https://gitlab.com/gitlab-org/release/docs/-/blob/master/scripts/README.md?ref_type=heads). diff --git a/runbooks/merging-with-a-red-pipeline.md b/runbooks/merging-with-a-red-pipeline.md index 121c6a7a62484ff09f6e5f63cafe498fa9505fbf..395eb0c593115b04950866843ae3eac7535f4d6c 100644 --- a/runbooks/merging-with-a-red-pipeline.md +++ b/runbooks/merging-with-a-red-pipeline.md @@ -2,7 +2,7 @@ tags: - "auto-deploy" --- -# Merging with a red pipeline. +# Merging with a red pipeline When preparing release work, Release Managers depend on protected branches to have green pipelines. Due to unrelated situations, these branches may have red pipelines preventing Release Managers from completing their work. diff --git a/runbooks/release-environment/README.md b/runbooks/release-environment/README.md index 9f0cdf8698e97b6a4aaf08373e52c4e5b294c952..07295917be08ef6efc14cfda8a919157a9e72279 100644 --- a/runbooks/release-environment/README.md +++ b/runbooks/release-environment/README.md @@ -7,4 +7,4 @@ - [No Slack notification when a deployment happens](no-slack-notification.md) - [Resolving QA failures](resolving-qa-failures.md) -This file is generated by generated-toc-file.sh. Check its [README here](https://gitlab.com/gitlab-org/release/docs/-/blob/master/scripts/README.md?ref_type=heads). \ No newline at end of file +This file is generated by generated-toc-file.sh. Check its [README here](https://gitlab.com/gitlab-org/release/docs/-/blob/master/scripts/README.md?ref_type=heads). diff --git a/runbooks/security/README.md b/runbooks/security/README.md index 41c1409c1ac2f31ee53d8c9bde89f310676b2a05..828e845d77bde38da82f871514b4d9a5d73f48f6 100644 --- a/runbooks/security/README.md +++ b/runbooks/security/README.md @@ -4,10 +4,11 @@ - [How to grant permissions for repo sync push](how-to-grant-permissions-for-repo-sync-push.md) - [Manually sync a release tag](manually-sync-release-tag.md) - [Remediation of GitLab environments in case of a critical vulnerability](mitigate-gitlab-environments-out-of-cycle.md) +- [Remove issues from patch release](remove-issues-from-patch-release.md) - [Remove Security Commit From A GitLab Component](remove-security-commit.md) - [Resolving Sync Failures](resolving-sync-failures.md) - [Revert a Security Merge Request](revert-security-merge-request.md) - [How to deal with security fixes breaking changes?](security_fixes_introducing_breaking_changes.md) - [How to handle upstream security patches](upstream_security_patches.md) -This file is generated by generated-toc-file.sh. Check its [README here](https://gitlab.com/gitlab-org/release/docs/-/blob/master/scripts/README.md?ref_type=heads). \ No newline at end of file +This file is generated by generated-toc-file.sh. Check its [README here](https://gitlab.com/gitlab-org/release/docs/-/blob/master/scripts/README.md?ref_type=heads). diff --git a/runbooks/security/remove-issues-from-patch-release.md b/runbooks/security/remove-issues-from-patch-release.md new file mode 100644 index 0000000000000000000000000000000000000000..2f4a78b64137d68db595b0ae4bfeda962a2d9aba --- /dev/null +++ b/runbooks/security/remove-issues-from-patch-release.md @@ -0,0 +1,15 @@ +# Remove issues from patch release + +## Context + +One of the first steps of a patch release process is to merge all security MRs to the default branch, called *early merge*. The merged pipelines of some MRs can fail due to an unforeseen bug. Since we have a tight schedule for patch releases, most of the time, we cannot wait for the issue to be fixed. In this case, we need to perform some manual actions to prevent the release automation from processing the failed MRs. + +> **Note**: Sometimes the merged pipelines fail because of flaky tests. We should check and retry them before concluding that they are issues to fix. + +## Steps + +The following steps need to be done in the tracking release issue. + +- Remove the issue from the list of `Linked items` +- Remove the row with the issue from the `Security issues` table: + - This table is in a comment added by the GitLab Release Tools Bot. The release automation updates this table during the release process. diff --git a/scripts/generate-toc-file.sh b/scripts/generate-toc-file.sh index 19a9bbe8a0ad1830d3139c6219f5bf1b83ab56f6..75ed154af8c7dc58949712dcc723985137beb9b2 100755 --- a/scripts/generate-toc-file.sh +++ b/scripts/generate-toc-file.sh @@ -32,7 +32,7 @@ write_readme() { echo "- [$title]($filename)" fi done - printf "\nThis file is generated by generated-toc-file.sh. Check its [README here](https://gitlab.com/gitlab-org/release/docs/-/blob/master/scripts/README.md?ref_type=heads)." + printf "\nThis file is generated by generated-toc-file.sh. Check its [README here](https://gitlab.com/gitlab-org/release/docs/-/blob/master/scripts/README.md?ref_type=heads).\n" } write_readme