From cd4a40b12dce5504212ac2d2b6af3514c19fff0b Mon Sep 17 00:00:00 2001 From: "courtmanr@gmail.com" Date: Sun, 2 Mar 2025 21:29:52 +0000 Subject: [PATCH] Clarify that release script is for maintainers only --- README.md | 9 ++++++++- scripts/release.sh | 10 ++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c940c32d2..d1b1cb31a 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/scripts/release.sh b/scripts/release.sh index 93e89c11b..08344f2b9 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -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'