Skip to content

Latest commit

 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

GitLab Documentation Skill for Claude Code - ULTIMATE Edition

The most comprehensive GitLab documentation resource for Claude Code - covering EVERYTHING from basic to advanced GitLab features.

Overview

This plugin transforms Claude Code into the ultimate GitLab expert by providing exhaustive documentation for ALL GitLab features. Whether you're working with APIs, CI/CD, security scanning, containers, or any GitLab feature, this skill has you covered.

Complete Feature Coverage

Core APIs (1000+ lines)

  • REST API - Complete API reference with all endpoints, authentication methods, rate limiting
  • GraphQL API - Modern GraphQL with queries, mutations, subscriptions, pagination, client libraries

Development Workflow (1500+ lines)

  • Projects - Creation, settings, templates, import/export, badges, mirroring, access control
  • Merge Requests - Complete MR workflow, code review, approvals, merge strategies, CODEOWNERS
  • Webhooks - All event types (push, MR, pipeline, etc.), payloads, security, handler examples

CI/CD & Deployment (1500+ lines)

  • CI/CD Pipelines - Complete .gitlab-ci.yml reference, jobs, artifacts, caching, DAG pipelines, security scanning
  • Runners - Installation on all platforms, all executors (Docker, Kubernetes, Shell, etc.), auto-scaling
  • GitLab Pages - Static site hosting with all major SSGs (Hugo, Jekyll, Gatsby, Next.js, etc.)

Security & Compliance (1000+ lines)

  • Security Scanning - SAST, DAST, dependency scanning, container scanning, secret detection, fuzz testing
  • Vulnerability Management - Security dashboard, policies, compliance frameworks, audit events
  • Authentication - PAT, OAuth 2.0, SSH, deploy tokens, 2FA, LDAP, SAML

Package Management (800+ lines)

  • Container Registry - Docker builds, multi-platform images, cleanup policies, Kaniko, Buildah
  • Package Registry - npm, Maven, PyPI, NuGet, Composer, Helm, Terraform, Conan, Go modules

Documentation Stats

  • 12+ comprehensive reference documents
  • 5,000+ lines of detailed documentation
  • 100+ production-ready code examples
  • Multiple programming languages (Python, JavaScript, Go, Ruby, Bash)
  • Complete API coverage (REST & GraphQL)
  • All CI/CD features documented
  • Every security scanner explained
  • All package formats supported

Installation

Quick Install

# In Claude Code, use the /plugin command:
/plugin https://github.com/lucacri/Claude-Gitlab-documentation

Manual Installation

# Clone the repository
git clone https://github.com/lucacri/Claude-Gitlab-documentation.git

# In Claude Code
/plugin /path/to/Claude-Gitlab-documentation

Usage

The skill automatically activates when you:

  • Ask questions about ANY GitLab feature
  • Work with GitLab API (REST or GraphQL)
  • Create or modify CI/CD pipelines
  • Set up security scanning
  • Configure webhooks or integrations
  • Manage containers or packages
  • Deploy with GitLab Pages
  • Work with merge requests, projects, or any GitLab feature

Example Interactions

GraphQL API Query:

You: "Show me how to fetch merge requests using GraphQL with pagination"
Claude: *Provides complete GraphQL query with pagination using gitlab skill*

Security Scanning Setup:

You: "Set up SAST, dependency scanning, and container scanning in my pipeline"
Claude: *Creates complete .gitlab-ci.yml with all security scanners configured*

Multi-Platform Docker Build:

You: "Build Docker image for AMD64, ARM64, and ARMv7"
Claude: *Provides complete pipeline with buildx configuration*

Package Publishing:

You: "Publish npm package to GitLab Package Registry"
Claude: *Complete setup with .npmrc, authentication, and CI/CD pipeline*

Complete Documentation Reference

Core APIs

  • api.md (300 lines) - REST API: Authentication, endpoints, rate limiting, error handling
  • graphql.md (500 lines) - GraphQL: Queries, mutations, subscriptions, pagination, introspection

Development Workflow

  • projects.md (450 lines) - Projects: Creation, settings, templates, members, import/export, mirroring
  • merge-requests.md (600 lines) - MRs: Workflow, reviews, approvals, merge strategies, code owners
  • webhooks.md (450 lines) - Webhooks: All events, payloads, handlers (Python/Node.js), testing

CI/CD & Deployment

  • ci-cd.md (600 lines) - Pipelines: Complete .gitlab-ci.yml, artifacts, caching, DAG, security
  • runners.md (500 lines) - Runners: Installation, executors, auto-scaling, monitoring
  • gitlab-pages.md (400 lines) - Pages: SSGs, custom domains, SSL, optimization

Security & Compliance

  • security.md (500 lines) - Scanning: SAST, DAST, dependencies, containers, secrets, compliance
  • authentication.md (450 lines) - Auth: All methods, OAuth, SSH, tokens, 2FA, LDAP, SAML

Package Management

  • container-registry.md (400 lines) - Containers: Builds, multi-platform, cleanup, scanning
  • package-registry.md (350 lines) - Packages: npm, Maven, PyPI, NuGet, Helm, Terraform, etc.

Why This is Ultimate

  1. Exhaustive Coverage - Every GitLab feature documented in detail
  2. Production-Ready Examples - Real-world code in multiple languages
  3. Best Practices Built-In - Industry standards for every feature
  4. Troubleshooting Included - Common issues and solutions
  5. Complete API Reference - Both REST and GraphQL fully documented
  6. Security-First - Comprehensive security and compliance docs
  7. Integration Ready - Webhook handlers, CI/CD templates, deployments
  8. Always Current - Based on latest GitLab capabilities

Use Cases

Perfect for:

  • API Development - Building integrations with GitLab
  • CI/CD Engineering - Creating sophisticated pipelines
  • DevSecOps - Implementing security scanning and compliance
  • Container Management - Building and managing Docker images
  • Package Publishing - Publishing packages in any format
  • Static Site Hosting - Deploying documentation and websites
  • GitLab Administration - Managing GitLab instances
  • Learning GitLab - Comprehensive reference for all features

What Makes This Different

Unlike basic GitLab documentation, this skill provides:

  • Contextual Help - Claude understands your needs and references the right docs
  • Code Generation - Get complete, working examples instantly
  • Best Practices - Not just "how" but "how best"
  • Multiple Languages - Examples in Python, JS, Go, Ruby, Bash
  • Complete Coverage - Nothing left out, everything documented
  • Real-World Focus - Production-ready solutions, not just tutorials

Contributing

Contributions welcome! To add or improve documentation:

  1. Fork the repository
  2. Create a feature branch
  3. Add/update documentation in gitlab-skill/skills/gitlab/references/
  4. Update SKILL.md if adding new sections
  5. Submit a pull request

Project Structure

Claude-Gitlab-documentation/
├── .claude-plugin/
│   └── marketplace.json          # Plugin marketplace config
├── gitlab-documentation-skill/
│   ├── .claude-plugin/
│   │   └── plugin.json           # Plugin metadata
│   └── skills/
│       └── gitlab/
│           ├── SKILL.md          # Skill definition (updated with all features)
│           └── references/       # 12+ comprehensive docs (5000+ lines)
│               ├── api.md
│               ├── graphql.md
│               ├── projects.md
│               ├── merge-requests.md
│               ├── webhooks.md
│               ├── ci-cd.md
│               ├── runners.md
│               ├── gitlab-pages.md
│               ├── security.md
│               ├── authentication.md
│               ├── container-registry.md
│               └── package-registry.md
├── README.md                     # This file
└── LICENSE

Requirements

  • Claude Code (latest version)
  • GitLab account (for testing features)

Version History

v2.0.0 - Ultimate Edition (2025-01-15)

  • 12+ comprehensive reference documents (5000+ lines)
  • Added GraphQL API complete documentation
  • Added Projects comprehensive management
  • Added Merge Requests detailed workflows
  • Added Security scanning (all types)
  • Added Container Registry complete guide
  • Added Package Registry (all formats)
  • Added GitLab Pages with SSGs
  • Updated SKILL.md with complete coverage
  • 100+ production-ready examples

v1.0.0 (2025-01-15)

  • Initial release with core documentation

License

MIT License - See LICENSE file for details.

Support

Author

Created for the GitLab and Claude Code community


Make Claude Code your ultimate GitLab expert! 🚀

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors