gitlab-org--gitlab-foss/doc
Kamil Trzciński 51830b6659 Merge branch '22849-ci-build-ref-slug' into 'master'
Introduce $CI_BUILD_REF_SLUG

## What does this MR do?

Adds `$CI_BUILD_REF_SLUG` to the variables exposed to the runner. This is based on `$CI_BUILD_REF_NAME` but lowercased, shortened to 63 bytes maximum, and with characters invalid in URLs and domain names replaced with `-`. 

## Are there points in the code the reviewer needs to double check?

Slugs don't have a uniqueness guarantee. !7983 introduces an environment name slug which *is* unique, so I'm not as exercised about this as I was.

Should the slug be published in the API? It's available through the `variables` endpoint, but perhaps it should be part of `GET /project/:id/builds` ?

I've called it `ref_slug` rather than just `slug` as there are number of possibilities for slugification in a build (unlike an environment, where only the name makes sense to slugify).

## Why was this MR needed?

`$CI_BUILD_REF_NAME` is not suited for URLs and domain names, given the list of valid characters in a git ref. 

## Screenshots (if relevant)

## Does this MR meet the acceptance criteria?

- [x] [Changelog entry](https://docs.gitlab.com/ce/development/changelog.html) added
- [X] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md)
- [ ] API support added
- Tests
  - [X] Added for this feature/bug
  - [x] All builds are passing
- [X] Conform by the [merge request performance guides](http://docs.gitlab.com/ce/development/merge_request_performance_guidelines.html)
- [X] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides)
- [X] Branch has no merge conflicts with `master` (if it does - rebase it please)
- [X] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits)

## What are the relevant issue numbers?

Closes #22849

See merge request !8072
2016-12-15 11:08:27 +00:00
..
administration Updating reference to database password 2016-12-08 13:47:16 -06:00
api Merge branch 'api-cherry-pick' into 'master' 2016-12-13 19:23:34 +00:00
ci Introduce $CI_BUILD_REF_SLUG 2016-12-13 19:31:23 +00:00
container_registry Move container_registry user docs to new location 2016-09-25 11:20:57 +02:00
customization Reduce size of images from 25MB to 13MB using pngquant 2016-11-22 19:53:43 +01:00
development Create animation page and clean up index 2016-12-05 14:09:24 -08:00
downgrade_ee_to_ce
gitlab-basics Reduce size of images from 25MB to 13MB using pngquant 2016-11-22 19:53:43 +01:00
hooks Change doc location of custom hooks 2016-07-05 15:04:44 +03:00
incoming_email Move reply by email docs to a new location 2016-09-25 11:55:14 +02:00
install [ci skip] Update "Installation from source" guide for 8.15.0 2016-12-09 15:28:41 -02:00
integration NIGNX -> Nginx 2016-12-05 14:37:44 +00:00
intro Move MWPS document to new location 2016-11-29 11:35:30 +01:00
legal remove undefined word Corporation from CCLA 2016-08-16 16:35:54 -07:00
logs
markdown Move markdown doc to the right location 2016-08-03 08:54:17 +03:00
migrate_ci_to_ce
monitoring Reduce size of images from 25MB to 13MB using pngquant 2016-11-22 19:53:43 +01:00
operations Move operations/ to new location 2016-10-11 16:13:04 +02:00
permissions Move permissions/permissions.md to user/permissions.md 2016-07-12 17:49:03 +03:00
profile Reduce size of images from 25MB to 13MB using pngquant 2016-11-22 19:53:43 +01:00
project_services Introduce deployment services, starting with a KubernetesService 2016-12-14 21:06:26 +00:00
public_access Change URLs to new permissions.md location 2016-07-12 18:03:29 +03:00
raketasks Add Human Readable Timestamp to backup tar file 2016-11-30 11:41:53 +01:00
security Reduce size of images from 25MB to 13MB using pngquant 2016-11-22 19:53:43 +01:00
ssh Refactor SSH keys docs 2016-12-09 12:49:07 +01:00
system_hooks
university new DevOps report, 404s, typos 2016-12-06 13:47:48 -07:00
update 8.14 requires GitLab shell 4.0.3 2016-12-12 19:11:57 +00:00
user Merge branch '23589-open-issue-for-mr' into 'master' 2016-12-06 14:04:14 +00:00
web_hooks Small refactor of webhooks docs 2016-12-01 13:19:00 +01:00
workflow Move MWPS document to new location 2016-11-29 11:35:30 +01:00
README.md Change docs title to represent the edition 2016-12-11 10:18:44 +01:00

README.md

GitLab Community Edition documentation

User documentation

Administrator documentation

Contributor documentation

  • Development All styleguides and explanations how to contribute.
  • Legal Contributor license agreements.