diff options
author | Kamil Trzciński <ayufan@ayufan.eu> | 2016-12-15 16:18:50 +0000 |
---|---|---|
committer | Kamil Trzciński <ayufan@ayufan.eu> | 2016-12-15 16:18:50 +0000 |
commit | dfdce39ad6860b54f7f0be7d91ef809d8da24c18 (patch) | |
tree | 315f45bc57dc2586941fd8766005f3d2813e740f /doc/api | |
parent | ada8b026ef55733a94821525249ed67a094d5521 (diff) | |
parent | 80513a129592583ed100e7a90fc9ea144eb62ea9 (diff) | |
download | gitlab-ce-dfdce39ad6860b54f7f0be7d91ef809d8da24c18.tar.gz |
Merge branch '22864-add-clean-environment-name' into 'master'
Add a slug to environments
## What does this MR do?
Adds a `slug` field to the `environments` table, populating existing rows and ensuring that new rows will get an entry.
Cleaning examples:
* `review/foo` => `review-foo-5gghdf`
* `review-foo` => `review-foo`
* `1-foo` => `env-1-foo-e2hx12`
* `production` => `production`
* `Production` => `production-f8ddlz`
## Are there points in the code the reviewer needs to double check?
This migration requires downtime. I don't see a way to avoid it.
## Why was this MR needed?
External services often have more restrictive rules on naming than those enforced for `environments.name`. In particular, forward slashes and names longer than 24 characters causes problems on OpenShift. `slug` is designed to be an acceptable alternative to `name` in these situations. Since forward slashes are a documented part of environment names, to set environment types, we need an envionmnent slug, not just a slug for the branch name.
## 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)
- [X] 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?
Part of #22864
See merge request !7983
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/enviroments.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/api/enviroments.md b/doc/api/enviroments.md index 87a5fa67124..1299aca8c45 100644 --- a/doc/api/enviroments.md +++ b/doc/api/enviroments.md @@ -22,8 +22,9 @@ Example response: [ { "id": 1, - "name": "Env1", - "external_url": "https://env1.example.gitlab.com" + "name": "review/fix-foo", + "slug": "review-fix-foo-dfjre3", + "external_url": "https://review-fix-foo-dfjre3.example.gitlab.com" } ] ``` @@ -54,6 +55,7 @@ Example response: { "id": 1, "name": "deploy", + "slug": "deploy", "external_url": "https://deploy.example.gitlab.com" } ``` @@ -85,6 +87,7 @@ Example response: { "id": 1, "name": "staging", + "slug": "staging", "external_url": "https://staging.example.gitlab.com" } ``` @@ -112,6 +115,7 @@ Example response: { "id": 1, "name": "deploy", + "slug": "deploy", "external_url": "https://deploy.example.gitlab.com" } ``` |