Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexbsrd/gitlab-tools
A collection of shell scripts to automate and streamline GitLab project management tasks.
https://github.com/alexbsrd/gitlab-tools
gitlab gitlab-api
Last synced: 15 days ago
JSON representation
A collection of shell scripts to automate and streamline GitLab project management tasks.
- Host: GitHub
- URL: https://github.com/alexbsrd/gitlab-tools
- Owner: AlexBsrd
- Created: 2025-01-17T18:07:28.000Z (15 days ago)
- Default Branch: main
- Last Pushed: 2025-01-17T19:12:26.000Z (15 days ago)
- Last Synced: 2025-01-17T20:24:06.232Z (15 days ago)
- Topics: gitlab, gitlab-api
- Language: Shell
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitLab Tools 🛠️
A collection of shell scripts to automate and streamline GitLab project management tasks. These tools help you monitor merge requests, track project activity, and analyze contributions.
## 📋 Requirements
- `bash` shell
- `curl` for API requests
- `jq` for JSON processing
- GitLab personal access token with appropriate permissions
## 🔧 Configuration
All scripts use environment variables for configuration.
**Required for all scripts:**
```bash
export GITLAB_URL="https://your-gitlab-instance.com"
export GITLAB_TOKEN="your-personal-access-token"
```
## 🚀 Available Scripts
### Merge Requests Automator
Automates merge request workflows by monitoring approvals, managing labels, and sending notifications.
```bash
# Process all merge requests
./merge-requests-automator.sh
# Process a specific merge request
./merge-requests-automator.sh PROJECT_ID MR_IID
```
**Additional configuration:**
```bash
export GROUP_ID="123" # Required
export APPROVAL_THRESHOLD="2" # Optional (default: 2)
export APPROVAL_LABEL="double-approved" # Optional
export READY_TO_MERGE_LABEL="ready-to-be-merged" # Optional
export BOT_USERNAME="gitlab-bot" # Optional
```
### Personal Contributions
Generates a detailed Markdown report of a user's merge request contributions.
```bash
./personal-contributions.sh USERNAME
```
**Additional configuration:**
```bash
export GROUP_ID="123" # Required
export MONTHS="6" # Optional (default: 6)
export OUTPUT_FILE="contributions.md" # Optional
```
### Merge Requests Stats
Analyzes merge request approval statistics and generates reviewer participation reports.
```bash
./merge-requests-stats.sh
```
**Additional configuration:**
```bash
export GROUP_ID="123" # Required
export MONTHS="3" # Optional (default: 3)
export EXCLUDE_BOTS="gitlab-bot" # Optional
```
### Project Activity Tracker
Tracks project activity based on merge request history and ranks projects by activity level.
```bash
./project-activity-tracker.sh
```
**Additional configuration:**
```bash
export GROUP_ID="123" # Required
export MONTHS="3" # Optional (default: 3)
export EXCLUDE_BOTS="bot1 bot2" # Optional
```
### Project Lister
Lists all projects in a GitLab group, including those in subgroups. Outputs clone URLs for easy access.
```bash
./project-lister.sh GROUP_ID
```
## 📝 Examples
### Generate Your Monthly Contributions Report
```bash
export GITLAB_URL="https://gitlab.company.com"
export GITLAB_TOKEN="your-token"
export GROUP_ID="123"
export MONTHS="1"
./personal-contributions.sh your-username
```
### Monitor Active Projects
```bash
export GITLAB_URL="https://gitlab.company.com"
export GITLAB_TOKEN="your-token"
export GROUP_ID="123"
export EXCLUDE_BOTS="gitlab-bot"
./project-activity-tracker.sh
```
### Clone All Group Projects
```bash
export GITLAB_URL="https://gitlab.company.com"
export GITLAB_TOKEN="your-token"
./project-lister.sh 123 | while read url; do
git clone "$url"
done
```
## 🔍 Help
All scripts support the `--help` flag which displays detailed usage information:
```bash
./script-name.sh --help
```
## 📌 Notes
- Scripts are designed to be non-destructive and read-only
- API pagination is handled automatically
- All timestamps are in UTC
## 🤝 Contributing
Contributions are welcome! Feel free to open issues or submit pull requests to improve these tools.
## 📄 License
This project is open source and available under the MIT License.