### Release notes <!-- What is the problem and solution you're proposing? This content sets the overall vision for the feature and serves as the release notes that will populate in various places, including the [release post blog](https://about.gitlab.com/releases/categories/releases/) and [Gitlab project releases](https://gitlab.com/gitlab-org/gitlab/-/releases). " --> ### Problem to Solve It's possible to want a `after_script` step for a gitlab-ci.yml, where it's important that it always run. However, the current behavior of `after_script` is that if a build is **canceled** the cleanup stage is skipped (even though this does not appear to be the original intent: https://gitlab.com/gitlab-org/gitlab-ci-multi-runner/issues/102#note_11619214). ### Proposal **Backend, Step 1** > NOTE: Gitlab communicates with the runner through the [`Runner API - resource :jobs`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/api/ci/runner.rb#L106) endpoint. A new keyword should be added to minimize the impacts to existing users so that they can opt-in the fix. See the following example: ```yaml job: after_script: script: - echo "Execute this command after the `script` section completes." when: always ``` Runner will receive the new keyword `when: always` via the API **Runner, Step 1** When the runner receives `canceling` status and job config `when: always` is set: - as usual, if the job is in either `created` or `pending`, it should transit directly to `canceled` and update the job to Gitlab. No `after_script` should be executed or no traces/artifacts should be uploaded. - if the job is `running`, it will abort the scripts, run the `after_script` and upload traces/artifacts. Once all is finished, it will transit to `canceled` and update the job to Gitlab **Backend, Step 2** - introduce the `canceling` status - when the job is in `canceling` state, allow traces/artifacts to be uploaded only when `when: always` is set **Frontend** The main Cancel :x: button on the Pipelines page should be a button for a graceful shutdown if `when: always`. **Backend, Step 3** - when graceful cancel button is click, job should transit to `canceling`. ### Intended users * [Sasha (Software Developer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sasha-software-developer) * [Devon (DevOps Engineer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#devon-devops-engineer) ### User experience goal <!-- What is the single user experience workflow this problem addresses? For example, "The user should be able to use the UI/API/.gitlab-ci.yml with GitLab to <perform a specific task>" https://about.gitlab.com/handbook/engineering/ux/ux-research-training/user-story-mapping/ --> When a user cancels a pipeline/job the `after_script` portion of jobs currently running should be executed. ### Permissions and Security * [ ] Add expected impact to members with no access (0) * [ ] Add expected impact to Guest (10) members * [x] Add expected impact to Reporter (20) members * [x] Add expected impact to Developer (30) members * [x] Add expected impact to Maintainer (40) members * [x] Add expected impact to Owner (50) members ### Documentation * This will require an update to the [`after_script`](https://docs.gitlab.com/ee/ci/yaml/#after_script) section of the docs. ### Availability & Testing <!-- This section needs to be retained and filled in during the workflow planning breakdown phase of this feature proposal, if not earlier. What risks does this change pose to our availability? How might it affect the quality of the product? What additional test coverage or changes to tests will be needed? Will it require cross-browser testing? Please list the test areas (unit, integration and end-to-end) that needs to be added or updated to ensure that this feature will work as intended. Please use the list below as guidance. * Unit test changes * Integration test changes * End-to-end test change See the test engineering planning process and reach out to your counterpart Software Engineer in Test for assistance: https://about.gitlab.com/handbook/engineering/quality/test-engineering/#test-planning --> ### What does success look like, and how can we measure that? <!-- Define both the success metrics and acceptance criteria. Note that success metrics indicate the desired business outcomes, while acceptance criteria indicate when the solution is working correctly. If there is no way to measure success, link to an issue that will implement a way to measure this. --> ### Links / references * This issue was split from https://gitlab.com/gitlab-org/gitlab/-/issues/15603+ * A POC was created and reviewed in this issue: https://gitlab.com/gitlab-org/gitlab/-/issues/361502+ <!-- triage-serverless v3 PLEASE DO NOT REMOVE THIS SECTION --> *This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.* <!-- triage-serverless v3 PLEASE DO NOT REMOVE THIS SECTION -->