diff options
| author | Nick Thomas <nick@gitlab.com> | 2019-03-13 20:40:06 +0300 |
|---|---|---|
| committer | Nick Thomas <nick@gitlab.com> | 2019-03-13 20:40:06 +0300 |
| commit | 8457768000e6bf542f335cd700ba7691e800df1b (patch) | |
| tree | cdb46426b59a4b7a717bb3e14afc6e46d6ac3a12 /doc/user/project/badges.md | |
| parent | ff26347d5e52a4c0b1d3ae690df1529bb8d7b5a1 (diff) | |
Update badge placeholder docs with privacy concerns
Diffstat (limited to 'doc/user/project/badges.md')
| -rw-r--r-- | doc/user/project/badges.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/user/project/badges.md b/doc/user/project/badges.md index 19eb95099ce..025f3af0af5 100644 --- a/doc/user/project/badges.md +++ b/doc/user/project/badges.md @@ -63,6 +63,12 @@ are available: - `%{commit_sha}`: ID of the most recent commit to the default branch of a project's repository +NOTE: **NOTE** +Placeholders allow badges to expose otherwise-private information, such as the +default branch or commit SHA when the project is configured to have a private +repository. This is by design, as badges are intended to be used publicly. Avoid +using these placeholders if the information is sensitive. + ## API You can also configure badges via the GitLab API. As in the settings, there is |