gitlab-badge

Name: gitlab-badge
Author: grandcamel

github.com/grandcamelDevelopment490 installsUpdated 41w ago

About gitlab-badge

A skill for managing GitLab project and group badges through `glab api`. It covers listing, previewing, creating, updating, and deleting badges, with example patterns for common status indicators.

Key features

01List project and group badges
02Inspect individual badge details
03Create, update, and delete badges
04Preview badge rendering
05Use placeholders in badge URLs
06Generate README badge Markdown

Use cases

01Add pipeline or coverage badges to a project
02Review rendered badge links and images
03Copy badge configurations between projects

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/grandcamel/gitlab-assistant-skills --skill gitlab-badge

After installing, type/gitlab-badgein Claude Code to confirm it loaded.

Details

From the project README

Badge Skill

Project badge management for GitLab using glab api raw endpoint calls.

Quick Reference

Operation	Command Pattern	Risk
List badges	`glab api projects/:id/badges`	-
Get badge	`glab api projects/:id/badges/:badge_id`	-
Create badge	`glab api projects/:id/badges -X POST -f ...`	⚠️
Update badge	`glab api projects/:id/badges/:badge_id -X PUT -f ...`	⚠️
Delete badge	`glab api projects/:id/badges/:badge_id -X DELETE`	⚠️
Preview badge	`glab api projects/:id/badges/render?...`	-
List group badges	`glab api groups/:id/badges`	-

Risk Legend: - Safe | ⚠️ Caution | ⚠️⚠️ Warning | ⚠️⚠️⚠️ Danger

When to Use This Skill

ALWAYS use when:

User mentions "badge", "status badge", "coverage badge"
User wants to add badges to README
User wants pipeline or build status indicators
User mentions badge links or badge images

NEVER use when:

User wants labels on issues/MRs (use gitlab-label)
User wants status of pipelines (use gitlab-ci)
User wants project settings (use gitlab-repo)

API Prerequisites

Required Token Scopes: api

Permissions:

Read badges: Reporter+
Manage badges: Maintainer+

Badge Placeholders

GitLab supports placeholders in badge URLs:

Placeholder	Description
`%{project_path}`	Full project path (e.g., `group/project`)
`%{project_id}`	Numeric project ID
`%{project_name}`	Project name
`%{project_namespace}`	Project namespace
`%{default_branch}`	Default branch name
`%{commit_sha}`	Current commit SHA

Available Commands

List Project Badges

# List all project badges
glab api projects/123/badges --method GET

# Using project path
glab api "projects/$(echo 'mygroup/myproject' | jq -Rr @uri)/badges"

List Group Badges

# List group badges (inherited by projects)
glab api groups/456/badges --method GET

Get Badge Details

# Get specific badge
glab api projects/123/badges/1 --method GET

Create Badge

# Create pipeline status badge
glab api projects/123/badges --method POST \
  -f link_url="https://gitlab.com/%{project_path}/-/pipelines" \
  -f image_url="https://gitlab.com/%{project_path}/badges/%{default_branch}/pipeline.svg"

# Create coverage badge
glab api projects/123/badges --method POST \
  -f link_url="https://gitlab.com/%{project_path}/-/jobs" \
  -f image_url="https://gitlab.com/%{project_path}/badges/%{default_branch}/coverage.svg"

# Create custom badge (e.g., shields.io)
glab api projects/123/badges --method POST \
  -f link_url="https://opensource.org/licenses/MIT" \
  -f image_url="https://img.shields.io/badge/License-MIT-yellow.svg"

# Create named badge
glab api projects/123/badges --method POST \
  -f name="Build Status" \
  -f link_url="https://gitlab.com/%{project_path}/-/pipelines" \
  -f image_url="https://gitlab.com/%{project_path}/badges/%{default_branch}/pipeline.svg"

# Create release badge
glab api projects/123/badges --method POST \
  -f link_url="https://gitlab.com/%{project_path}/-/releases" \
  -f image_url="https://gitlab.com/%{project_path}/-/badges/release.svg"

Update Badge

# Update badge URLs
glab api projects/123/badges/1 --method PUT \
  -f link_url="https://new-link.com" \
  -f image_url="https://new-image.com/badge.svg"

# Update badge name
glab api projects/123/badges/1 --method PUT \
  -f name="New Badge Name"

Delete Badge

# Delete badge
glab api projects/123/badges/1 --method DELETE

Preview Badge Rendering

# Preview how a badge would render
glab api "projects/123/badges/render?link_url=https://gitlab.com/%{project_path}&image_url=https://gitlab.com/%{project_path}/badges/%{default_branch}/pipeline.svg" --method GET

Common Badge Templates

Pipeline Status Badge

# Link and image URLs
link_url="https://gitlab.com/%{project_path}/-/pipelines"
image_url="https://gitlab.com/%{project_path}/badges/%{default_branch}/pipeline.svg"

glab api projects/123/badges --method POST \
  -f link_url="$link_url" \
  -f image_url="$image_url"

Markdown: [![pipeline status](https://gitlab.com/group/project/badges/main/pipeline.svg)](https://gitlab.com/group/project/-/pipelines)

Coverage Badge

link_url="https://gitlab.com/%{project_path}/-/jobs"
image_url="https://gitlab.com/%{project_path}/badges/%{default_branch}/coverage.svg"

glab api projects/123/badges --method POST \
  -f link_url="$link_url" \
  -f image_url="$image_url"

Release Badge

link_url="https://gitlab.com/%{project_path}/-/releases"
image_url="https://gitlab.com/%{project_path}/-/badges/release.svg"

glab api projects/123/badges --method POST \
  -f link_url="$link_url" \
  -f image_url="$image_url"

Custom Shields.io Badges

# License badge
glab api projects/123/badges --method POST \
  -f name="License" \
  -f link_url="https://opensource.org/licenses/MIT" \
  -f image_url="https://img.shields.io/badge/License-MIT-blue.svg"

# Version badge
glab api projects/123/badges --method POST \
  -f name="Version" \
  -f link_url="https://gitlab.com/%{project_path}/-/releases" \
  -f image_url="https://img.shields.io/badge/version-1.0.0-green.svg"

# Maintenance badge
glab api projects/123/badges --method POST \
  -f name="Maintained" \
  -f link_url="https://gitlab.com/%{project_path}" \
  -f image_url="https://img.shields.io/badge/Maintained%3F-yes-green.svg"

Common Workflows

Workflow 1: Set Up Standard Badges

project_id=123

# Pipeline status
glab api projects/$project_id/badges --method POST \
  -f name="Pipeline" \
  -f link_url="https://gitlab.com/%{project_path}/-/pipelines" \
  -f image_url="https://gitlab.com/%{project_path}/badges/%{default_branch}/pipeline.svg"

# Coverage
glab api projects/$project_id/badges --method POST \
  -f name="Coverage" \
  -f link_url="https://gitlab.com/%{project_path}/-/jobs" \
  -f image_url="https://gitlab.com/%{project_path}/badges/%{default_branch}/coverage.svg"

# Latest release
glab api projects/$project_id/badges --method POST \
  -f name="Release" \
  -f link_url="https://gitlab.com/%{project_path}/-/releases" \
  -f image_url="https://gitlab.com/%{project_path}/-/badges/release.svg"

Workflow 2: Generate README Badge Markdown

# Get all badges and generate markdown
glab api projects/123/badges | \
  jq -r '.[] | "[![\(.name // "badge")](\(.rendered_image_url))](\(.rendered_link_url))"'

Workflow 3: Copy Badges to Another Project

source_project=123
target_project=456

# Get badges from source
badges=$(glab api projects/$source_project/badges)

# Create in target (using placeholders, so they'll work for the new project)
echo "$badges" | jq -c '.[]' | while read badge; do
  link_url=$(echo "$badge" | jq -r '.link_url')
  image_url=$(echo "$badge" | jq -r '.image_url')
  name=$(echo "$badge" | jq -r '.name // empty')

  glab api projects/$target_project/badges --method POST \
    -f link_url="$link_url" \
    -f image_url="$image_url" \
    ${name:+-f name="$name"}
done

Workflow 4: Audit Badge Configuration

# List all badges with rendered URLs
glab api projects/123/badges | \
  jq -r '.[] | "ID: \(.id)\n  Name: \(.name // "unnamed")\n  Image: \(.rendered_image_url)\n  Link: \(.rendered_link_url)\n"'

Workflow 5: Replace All Badges

project_id=123

# Delete existing badges
glab api projects/$project_id/badges | jq -r '.[].id' | while read badge_id; do
  glab api projects/$project_id/badges/$badge_id --method DELETE
done

# Create new badges
glab api projects/$project_id/badges --method POST \
  -f name="Build" \
  -f link_url="https://gitlab.com/%{project_path}/-/pipelines" \
  -f image_url="https://gitlab.com/%{project_path}/badges/%{default_branch}/pipeline.svg"

Troubleshooting

Issue	Cause	Solution
Badge not showing	URL incorrect	Check rendered URLs in API response
403 Forbidden	Not maintainer	Need Maintainer+ role
Placeholder not replaced	Wrong syntax	Use `%{placeholder}` format
Coverage badge shows "unknown"	No coverage report	Configure CI to output coverage
Pipeline badge shows old status	Cache	Badge images may be cached

Badge Best Practices

Use placeholders: Make badges portable between projects
Name your badges: Helps identify them in the list
Link to relevant pages: Badge clicks should go somewhere useful
Keep badges updated: Remove stale badges
Use consistent styling: Mix of GitLab and shields.io can look inconsistent

Comments

Markdown supported

Details

Author: grandcamel
Repository: grandcamel/gitlab-assistant-skills
Category: Development
Installs: 90
GitHub stars: 4

Report

More skills

All skills

remotion-render

github.com/inference-sh

1.6M

Render videos from React/Remotion component code via inference.sh. Pass TSX code, get MP4. Supports all Remotion APIs: useCurrentFrame, useVideoConfig, spring, interpolate, AbsoluteFill, Sequence. Configurable resolution, FPS, duration, codec. Use for: programmatic video generation, animated graphics, motion design, data-driven videos, React animations to video. Triggers: remotion, render video from code, tsx to video, react video, programmatic video, remotion render, code to video, animated video, motion graphics code, react animation video

design-mobile-apps

github.com/designed-by-ai

1.3M

Design mobile app screens with Sleek, edit Sleek projects, and implement their designs in React Native or HTML

improve-codebase-architecture

github.com/mattpocock

1.2M

Scan a codebase for architecture improvement opportunities, present them as a visual HTML report, then dive deep into whichever one you pick.

vercel-react-best-practices

github.com/vercel-labs

879.3k

React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.

gitlab-badge

About gitlab-badge

Key features

Use cases

Install

Details

Badge Skill

Quick Reference

When to Use This Skill

API Prerequisites

Badge Placeholders

Available Commands

List Project Badges

List Group Badges

Get Badge Details

Create Badge

Update Badge

Delete Badge

Preview Badge Rendering

Common Badge Templates

Pipeline Status Badge

Coverage Badge

Release Badge

Custom Shields.io Badges

Common Workflows

Workflow 1: Set Up Standard Badges

Workflow 2: Generate README Badge Markdown

Workflow 3: Copy Badges to Another Project

Workflow 4: Audit Badge Configuration

Workflow 5: Replace All Badges

Troubleshooting

Badge Best Practices

Related Documentation

Comments