Clarify that release script is for maintainers only

This commit is contained in:
courtmanr@gmail.com
2025-03-02 21:29:52 +00:00
parent aa385fb586
commit cd4a40b12d
2 changed files with 18 additions and 1 deletions
+8 -1
View File
@@ -326,7 +326,14 @@ A release script is provided to automate the process of creating new releases. T
- Docker image building and pushing
- GitHub release creation
To create a new release:
> **⚠️ Note for Contributors**: This release script is intended for repository maintainers only. It requires:
> - Write access to the GitHub repository
> - Docker Hub authentication with push permissions
> - GitHub CLI authentication with release creation permissions
>
> Regular contributors should not attempt to run this script. Instead, please follow the [Contributing](#contributing) guidelines for submitting changes.
For repository maintainers, to create a new release:
```bash
# Create a new patch release (1.0.x → 1.0.x+1)
+10
View File
@@ -1,6 +1,16 @@
#!/bin/bash
set -e
# ⚠️ MAINTAINER ONLY SCRIPT ⚠️
# This script is intended for repository maintainers only.
# It requires:
# - Write access to the GitHub repository
# - Docker Hub authentication with push permissions
# - GitHub CLI authentication with release creation permissions
#
# Regular contributors should not attempt to run this script.
# Instead, please follow the Contributing guidelines in the README.
# Colors for output
GREEN='\033[0;32m'
YELLOW='\033[1;33m'