Skip to content

Leave clear notices in docs about after_script execution context

Tomasz Maczukin requested to merge docs/make-it-clear-about-after-script-context into master

What does this MR do?

Leave clear notices about after_script execution context

We frequently see new issues mentioning that something defined in before_script or script doesn't work with after_script.

Our documentation mentions that first two are concatenated and executed together, why the third one is executed in a separated shell context. But it looks like it's not clear enough.

Since this misunderstanding of how scripts are being executed is repeated frequently, let's make it more clear in docs.

Related issues

Example of such issue: gitlab-runner#4146 (closed)

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the ~Documentation label.

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Closes gitlab-runner#4146 (closed)

Merge request reports