ComputerSurge/shields
3
0
Fork 0
Code Pull Requests 1 Activity

[gitlab] Add documentation for publicity state of pipelines (#4218)

Browse Source 
* Add documentation for publicity state of pipelines

* Modify visual picture to be smaller and add red circle to mark important setting

* Adapt suggestion

Co-Authored-By: Caleb Cartwright <calebcartwright@users.noreply.github.com>
This commit is contained in:
Michael Schmitz
2019-10-20 19:14:55 +02:00
committed by Caleb Cartwright
parent 3ceede8f1d
commit f82f7b798d
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
services/gitlab/gitlab-pipeline-status.service.js
View File

@@ -15,6 +15,25 @@ const queryParamSchema = Joi.object({
gitlab_url: optionalUrl,
}).required()
const documentation = `
<p>
Important: If your project is publicly visible, but the badge is like this:
<img src="https://img.shields.io/badge/build-not&nbsp;found-red" alt="build not found"/>
</p>
<p>
Check if your pipelines are publicly visible as well.<br />
Navigate to your project settings on GitLab and choose General Pipelines under CI/CD.<br />
Then tick the setting Public pipelines.
</p>
<p>
Now your settings should look like this:
</p>
<img src="https://user-images.githubusercontent.com/12065866/67156911-e225a180-f324-11e9-93ad-10aafbb3e69e.png" alt="Setting Public pipelines set"/>
<p>
Your badge should be working fine now.
</p>
`
module.exports = class GitlabPipelineStatus extends BaseSvgScrapingService {
static get category() {
return 'build'
@@ -35,6 +54,7 @@ module.exports = class GitlabPipelineStatus extends BaseSvgScrapingService {
pattern: ':user/:repo',
namedParams: { user: 'gitlab-org', repo: 'gitlab-ce' },
staticPreview: this.render({ status: 'passed' }),
documentation,
},
{
title: 'Gitlab pipeline status (branch)',
@@ -45,6 +65,7 @@ module.exports = class GitlabPipelineStatus extends BaseSvgScrapingService {
branch: 'master',
},
staticPreview: this.render({ status: 'passed' }),
documentation,
},
{
title: 'Gitlab pipeline status (self-hosted)',
@@ -52,6 +73,7 @@ module.exports = class GitlabPipelineStatus extends BaseSvgScrapingService {
namedParams: { user: 'GNOME', repo: 'pango' },
queryParams: { gitlab_url: 'https://gitlab.gnome.org' },
staticPreview: this.render({ status: 'passed' }),
documentation,
},
]
}