diff --git a/doc/user/project/pages/index.md b/doc/user/project/pages/index.md index bb64034b0bef2e78220eb1c9f5858ccba951499b..0c9e2fc5874cefa8e1576a1c64c75b324f861c79 100644 --- a/doc/user/project/pages/index.md +++ b/doc/user/project/pages/index.md @@ -412,41 +412,43 @@ To restore a stopped deployment that has not been deleted yet, see Parallel Pages deployments, created by a merge request with a `path_prefix`, are automatically deleted when the merge request is closed or merged. -## User defined job names +## User-defined job names > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/232505) in GitLab 17.5 with a flag `customizable_pages_job_name`, disabled by default. -> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169095) in GitLab 17.6. +> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/169095) in GitLab 17.6. Feature flag `customizable_pages_job_name` removed. -To trigger a pages deployment from any job, include the `pages` property in the -job definition. It can either be a hash or simply a boolean set to `true` +To trigger a Pages deployment from any job, include the `pages` property in the +job definition. It can either be a hash or a Boolean set to `true`. + +For example, using `true`: ```yaml -deploy-my-pages-site: +deploy-pages-review-app: stage: deploy script: - npm run build - pages: true + pages: + path_prefix: '/_staging' artifacts: paths: - public ``` -This also works: +For example, using a hash: ```yaml -deploy-pages-review-app: +deploy-my-pages-site: stage: deploy script: - npm run build - pages: - path_prefix: '/_staging' + pages: true artifacts: paths: - public ``` If the `pages` property of a job named `pages` is set to `false`, no -deployment will be triggered. +deployment is triggered: ```yaml pages: