diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-11-14 00:06:24 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-11-14 00:06:24 +0000 |
commit | eed996ac33a60d5fd8315a62fec8beaa8e907e69 (patch) | |
tree | d8077bee50b58a170ae1a950ae76e3011c78a415 /doc | |
parent | b42f312df5aee0f1b832b69171e9d1cf92eb7416 (diff) | |
download | gitlab-ce-eed996ac33a60d5fd8315a62fec8beaa8e907e69.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/packages.md | 2 | ||||
-rw-r--r-- | doc/ci/yaml/README.md | 44 | ||||
-rw-r--r-- | doc/development/feature_flags/development.md | 16 |
3 files changed, 51 insertions, 11 deletions
diff --git a/doc/api/packages.md b/doc/api/packages.md index 52cc1d5c97e..bab3f91bc40 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -61,7 +61,7 @@ GET /groups/:id/packages | `exclude_subgroups` | boolean | false | If the param is included as true, packages from projects from subgroups are not listed. Default is `false`. | ```bash -curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/group/:id/packages?exclude_subgroups=true +curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/packages?exclude_subgroups=true ``` Example response: diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index ea67617ff5c..27ced0eecf5 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -1535,6 +1535,50 @@ cache: - binaries/ ``` +##### `cache:key:files` + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/18986) in GitLab v12.5. + +If `cache:key:files` is added, the cache `key` will use the SHA of the most recent commit +that changed either of the given files. If neither file was changed in any commits, the key will be `default`. +A maximum of two files are allowed. + +```yaml +cache: + key: + files: + - Gemfile.lock + - package.json + paths: + - vendor/ruby + - node_modules +``` + +##### `cache:key:prefix` + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/18986) in GitLab v12.5. + +The `prefix` parameter adds extra functionality to `key:files` by allowing the key to +be composed of the given `prefix` combined with the SHA of the most recent commit +that changed either of the files. For example, adding a `prefix` of `rspec`, will +cause keys to look like: `rspec-feef9576d21ee9b6a32e30c5c79d0a0ceb68d1e5`. If neither +file was changed in any commits, the prefix is added to `default`, so the key in the +example would be `rspec-default`. + +`prefix` follows the same restrictions as `key`, so it can use any of the +[predefined variables](../variables/README.md). Similarly, the `/` character or the +equivalent URI-encoded `%2F`, or a value made only of `.` or `%2E`, is not allowed. + +```yaml +cache: + key: + files: + - Gemfile.lock + prefix: ${CI_JOB_NAME} + paths: + - vendor/ruby +``` + #### `cache:untracked` Set `untracked: true` to cache all files that are untracked in your Git diff --git a/doc/development/feature_flags/development.md b/doc/development/feature_flags/development.md index de8098434c2..1ce9525d74e 100644 --- a/doc/development/feature_flags/development.md +++ b/doc/development/feature_flags/development.md @@ -52,20 +52,16 @@ isn't gated by a License or Plan. [namespace-fa]: https://gitlab.com/gitlab-org/gitlab/blob/4cc1c62918aa4c31750cb21dfb1a6c3492d71080/ee/app/models/ee/namespace.rb#L71-85 [license-fa]: https://gitlab.com/gitlab-org/gitlab/blob/4cc1c62918aa4c31750cb21dfb1a6c3492d71080/ee/app/models/license.rb#L293-300 -An important side-effect of the implicit feature flags mentioned above is that +**An important side-effect of the implicit feature flags mentioned above is that unless the feature is explicitly disabled or limited to a percentage of users, -the feature flag check will default to `true`. +the feature flag check will default to `true`.** As an example, if you were to ship the backend half of a feature behind a flag, you'd want to explicitly disable that flag until the frontend half is also ready -to be shipped. [You can do this via Chatops](controls.md): - -``` -/chatops run feature set some_feature 0 -``` - -Note that you can do this at any time, even before the merge request using the -flag has been merged! +to be shipped. To make sure this feature is disabled for both GitLab.com and +self-managed instances you'd need to explicitly call `Feature.enabled?` method +before the `feature_available` method. This ensures the feature_flag is defaulting +to `true`. ## Feature groups |