Skip to content

Commit ce62050

Browse files
d0ugald0ugal
committed
🚀 Initial commit: GHCR Exporter - A Prometheus exporter for GitHub Container Registry metrics
✨ Features: - Real-time metrics collection from GHCR packages - Prometheus-compatible metrics endpoint - Web UI for monitoring and configuration - Docker support with health checks - Comprehensive test coverage 🔧 Technical highlights: - Go-based implementation with clean architecture - GitHub API integration with rate limiting - Configurable package monitoring - Structured logging and error handling - CI/CD pipeline with automated releases 📚 Documentation: - Complete README with quickstart guide - Contributing guidelines and code of conduct - Security policy and changelog - Docker Compose examples 🎯 Ready for production deployment!
0 parents  commit ce62050

31 files changed

+2854
-0
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
8+
env:
9+
REGISTRY: ghcr.io
10+
IMAGE_NAME: ${{ github.repository }}
11+
12+
jobs:
13+
test:
14+
name: Test
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout code
19+
uses: actions/checkout@v5
20+
21+
- name: Set up Go 1.25
22+
uses: actions/setup-go@v5
23+
with:
24+
go-version: '1.25'
25+
26+
- name: Install dependencies
27+
run: go mod download
28+
29+
- name: Run tests
30+
run: go test -v -race -coverprofile=coverage.txt -covermode=atomic ./...
31+
32+
- name: Upload coverage to Codecov
33+
uses: codecov/codecov-action@v5
34+
with:
35+
file: ./coverage.txt
36+
flags: unittests
37+
name: codecov-umbrella
38+
39+
lint:
40+
name: Lint
41+
runs-on: ubuntu-latest
42+
continue-on-error: true
43+
44+
steps:
45+
- name: Checkout code
46+
uses: actions/checkout@v5
47+
48+
- name: Run golangci-lint
49+
uses: golangci/golangci-lint-action@v8
50+
with:
51+
version: latest
52+
53+
build:
54+
name: Build
55+
runs-on: ubuntu-latest
56+
needs: [test]
57+
58+
steps:
59+
- name: Checkout code
60+
uses: actions/checkout@v5
61+
62+
- name: Set up Go
63+
uses: actions/setup-go@v5
64+
with:
65+
go-version: '1.25'
66+
67+
- name: Build
68+
run: |
69+
go build -v -ldflags="-s -w" -o ghcr-exporter ./cmd
70+
71+
- name: Upload build artifacts
72+
uses: actions/upload-artifact@v4
73+
with:
74+
name: ghcr-exporter
75+
path: ghcr-exporter
76+
retention-days: 30
77+
78+
security:
79+
name: Security Scan
80+
runs-on: ubuntu-latest
81+
permissions:
82+
contents: read
83+
security-events: write
84+
85+
steps:
86+
- name: Checkout code
87+
uses: actions/checkout@v5
88+
89+
- name: Run Trivy vulnerability scanner
90+
uses: aquasecurity/trivy-action@master
91+
with:
92+
scan-type: 'fs'
93+
scan-ref: '.'
94+
format: 'table'
95+
exit-code: '1'
96+
severity: 'CRITICAL,HIGH'
97+
98+
dev-build:
99+
name: Development Build
100+
runs-on: ubuntu-latest
101+
needs: [test]
102+
if: github.event_name == 'push'
103+
permissions:
104+
contents: read
105+
packages: write
106+
107+
steps:
108+
- name: Checkout code
109+
uses: actions/checkout@v5
110+
111+
- name: Set up Docker Buildx
112+
uses: docker/setup-buildx-action@v3
113+
114+
- name: Log in to GHCR
115+
uses: docker/login-action@v3
116+
with:
117+
registry: ${{ env.REGISTRY }}
118+
username: ${{ github.actor }}
119+
password: ${{ secrets.GITHUB_TOKEN }}
120+
121+
- name: Generate dev tag
122+
id: meta
123+
run: |
124+
# Create a dev tag with commit SHA and timestamp
125+
SHORT_SHA=$(echo ${{ github.sha }} | cut -c1-7)
126+
TIMESTAMP=$(date +%Y%m%d-%H%M%S)
127+
DEV_TAG="dev-${TIMESTAMP}-${SHORT_SHA}"
128+
echo "dev_tag=${DEV_TAG}" >> $GITHUB_OUTPUT
129+
echo "Generated dev tag: ${DEV_TAG}"
130+
131+
- name: Extract metadata
132+
id: docker_meta
133+
uses: docker/metadata-action@v5
134+
with:
135+
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
136+
tags: |
137+
${{ steps.meta.outputs.dev_tag }}
138+
dev
139+
140+
- name: Build and push Docker image
141+
uses: docker/build-push-action@v6
142+
with:
143+
context: .
144+
platforms: linux/amd64,linux/arm64
145+
push: true
146+
tags: ${{ steps.docker_meta.outputs.tags }}
147+
labels: ${{ steps.docker_meta.outputs.labels }}
148+
cache-from: type=gha
149+
cache-to: type=gha,mode=min
150+
continue-on-error: false

‎.github/workflows/release-please.yml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: Release Please
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
7+
permissions:
8+
contents: write
9+
pull-requests: write
10+
issues: write
11+
packages: write
12+
13+
env:
14+
REGISTRY: ghcr.io
15+
IMAGE_NAME: ${{ github.repository }}
16+
17+
jobs:
18+
release-please:
19+
runs-on: ubuntu-latest
20+
21+
steps:
22+
- uses: actions/checkout@v5
23+
with:
24+
fetch-depth: 0
25+
token: ${{ secrets.GITHUB_TOKEN }}
26+
27+
- uses: googleapis/release-please-action@v4
28+
id: release_please
29+
with:
30+
release-type: go
31+
path: .
32+
token: ${{ secrets.GITHUB_TOKEN }}
33+
34+
# Debug info
35+
- name: Debug Release Info
36+
if: steps.release_please.outputs.release_created == 'true'
37+
run: |
38+
echo "Release created!"
39+
echo "Tag: ${{ steps.release_please.outputs.tag_name }}"
40+
echo "Name: ${{ steps.release_please.outputs.name }}"
41+
echo "Draft: ${{ steps.release_please.outputs.draft }}"
42+
echo "Prerelease: ${{ steps.release_please.outputs.prerelease }}"
43+
44+
# Build and push Docker image
45+
- name: Set up Docker Buildx
46+
if: steps.release_please.outputs.release_created == 'true'
47+
uses: docker/setup-buildx-action@v3
48+
49+
- name: Log in to GHCR
50+
if: steps.release_please.outputs.release_created == 'true'
51+
uses: docker/login-action@v3
52+
with:
53+
registry: ${{ env.REGISTRY }}
54+
username: ${{ github.actor }}
55+
password: ${{ secrets.GITHUB_TOKEN }}
56+
57+
- name: Extract metadata
58+
if: steps.release_please.outputs.release_created == 'true'
59+
id: meta
60+
uses: docker/metadata-action@v5
61+
with:
62+
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
63+
tags: |
64+
${{ steps.release_please.outputs.tag_name }}
65+
latest
66+
67+
- name: Build and push Docker image
68+
if: steps.release_please.outputs.release_created == 'true'
69+
uses: docker/build-push-action@v6
70+
with:
71+
context: .
72+
platforms: linux/amd64,linux/arm64
73+
push: true
74+
tags: ${{ steps.meta.outputs.tags }}
75+
labels: ${{ steps.meta.outputs.labels }}
76+
cache-from: type=gha,scope=release-${{ steps.release_please.outputs.tag_name }}
77+
cache-to: type=gha,mode=max,scope=release-${{ steps.release_please.outputs.tag_name }}
78+
continue-on-error: false
79+
build-args: |
80+
VERSION=${{ steps.release_please.outputs.tag_name }}
81+
COMMIT=${{ github.sha }}
82+
BUILD_DATE=${{ github.event.head_commit.timestamp }}

‎.gitignore‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Binaries for programs and plugins
2+
*.exe
3+
*.exe~
4+
*.dll
5+
*.so
6+
*.dylib
7+
8+
# Test binary, built with `go test -c`
9+
*.test
10+
11+
# Output of the go coverage tool, specifically when used with LiteIDE
12+
*.out
13+
14+
# Dependency directories (remove the comment below to include it)
15+
# vendor/
16+
17+
# Go workspace file
18+
go.work
19+
20+
# Build artifacts
21+
ghcr-exporter
22+
coverage.txt
23+
24+
# IDE files
25+
.vscode/
26+
.idea/
27+
*.swp
28+
*.swo
29+
30+
# OS generated files
31+
.DS_Store
32+
.DS_Store?
33+
._*
34+
.Spotlight-V100
35+
.Trashes
36+
ehthumbs.db
37+
Thumbs.db
38+
39+
# Logs
40+
*.log
41+
42+
# Configuration files (optional - remove if you want to track them)
43+
config.yaml

‎.golangci.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
version: "2"
2+
3+
run:
4+
timeout: 5m
5+
go: "1.25"
6+
7+
linters:
8+
# Use fast linters for better performance
9+
default: fast
10+
enable:
11+
- govet
12+
- staticcheck
13+
- errcheck
14+
- gosec
15+
- ineffassign
16+
- unused
17+
- contextcheck
18+
- wsl_v5
19+
20+
disable:
21+
- cyclop # Too strict
22+
- depguard # Allow internal imports
23+
- err113 # Allow dynamic errors
24+
- exhaustruct # Too strict for tests
25+
- forcetypeassert # Allow in tests
26+
- funcorder # Not critical
27+
- funlen # Allow longer functions
28+
- gocognit # Too strict
29+
- goconst # Not critical
30+
- godot # Not critical
31+
- intrange # Go 1.22+ feature
32+
- lll # Line length not critical
33+
- mnd # Magic numbers acceptable
34+
- nestif # Allow nested if
35+
- nlreturn # Not critical
36+
- noinlineerr # Allow inline errors
37+
- paralleltest # Not critical
38+
- perfsprint # Not critical
39+
- revive # Too many false positives
40+
- tagliatelle # YAML tags fine
41+
- testpackage # Allow test packages
42+
- usetesting # Not critical
43+
- varnamelen # Variable names fine
44+
- wsl # Use wsl_v5 instead
45+
- gosec # Security warnings are false positives for this codebase
46+
47+
settings:
48+
gosec:
49+
# Allow some security warnings
50+
excludes:
51+
- G204 # Subprocess launched with variable - inputs are validated and sanitized
52+
- G304 # Potential file inclusion via variable - path is validated and comes from trusted config
53+
54+
formatters:
55+
enable:
56+
- gci
57+
- gofmt

‎.release-please-config.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"packages": {
3+
".": {
4+
"changelog-path": "CHANGELOG.md",
5+
"release-type": "go",
6+
"bump-minor-pre-major": true,
7+
"bump-patch-for-minor-pre-major": true,
8+
"include-component-in-tag": false,
9+
"include-v-in-tag": true
10+
}
11+
},
12+
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
13+
}
14+
15+

‎CHANGELOG.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Changelog
2+
3+
All notable changes to ghcr-exporter will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Features
11+
12+
* Initial release of ghcr-exporter
13+
* Collects package download statistics from GitHub Container Registry (GHCR)
14+
* Tracks package version counts and last published timestamps
15+
* Supports both user and organization packages
16+
* Prometheus metrics endpoint with health checks
17+
* Docker support with non-root user
18+
* Graceful error handling and retry logic
19+
* Web UI with metrics information
20+
* GitHub API integration with authentication
21+
22+
### Metrics
23+
24+
* `ghcr_exporter_info` - Information about the exporter
25+
* `ghcr_package_downloads_total` - Version count (proxy for package activity)
26+
* `ghcr_package_last_published_timestamp` - Last published timestamp
27+
* `ghcr_collection_duration_seconds` - Collection duration
28+
* `ghcr_collection_success_total` - Successful collections
29+
* `ghcr_collection_failed_total` - Failed collections
30+
* `ghcr_collection_interval_seconds` - Collection interval
31+
* `ghcr_collection_timestamp` - Last collection timestamp

0 commit comments

Comments
 (0)