Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
f5793b5a
Commit
f5793b5a
authored
May 19, 2021
by
Caleb Williamson
Committed by
Marcin Sedlak-Jakubowski
May 19, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add custom badge images section to badges documentation
parent
a0afbe1d
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
29 additions
and
0 deletions
+29
-0
doc/user/project/badges.md
doc/user/project/badges.md
+29
-0
No files found.
doc/user/project/badges.md
View file @
f5793b5a
...
@@ -90,6 +90,35 @@ default branch or commit SHA when the project is configured to have a private
...
@@ -90,6 +90,35 @@ 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
repository. This is by design, as badges are intended to be used publicly. Avoid
using these placeholders if the information is sensitive.
using these placeholders if the information is sensitive.
## Use custom badge images
Use custom badge images in a project or a group if you want to use badges other than the default
ones.
Prerequisites:
-
A valid URL that points directly to the desired image for the badge.
If the image is located in a GitLab repository, use the raw link to the image.
Using placeholders, here is an example badge image URL referring to a raw image at the root of a repository:
```
plaintext
https://gitlab.example.com/<project_path>/-/raw/<default_branch>/my-image.svg
```
To add a new badge to a group or project with a custom image:
1.
Go to your group or project and select
**Settings > General**
.
1.
Expand
**Badges**
.
1.
Under
**Name**
, enter the name for the badge.
1.
Under
**Link**
, enter the URL that the badge should point to.
1.
Under
**Badge image URL**
, enter the URL that points directly to the custom image that should be
displayed.
1.
Select
**Add badge**
.
To learn how to use custom images generated via a pipeline, see our documentation on
[
accessing the latest job artifacts by URL
](
../../ci/pipelines/job_artifacts.md#access-the-latest-job-artifacts-by-url
)
.
## API
## API
You can also configure badges via the GitLab API. As in the settings, there is
You can also configure badges via the GitLab API. As in the settings, there is
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment