diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md new file mode 100644 index 0000000..7d649a7 --- /dev/null +++ b/RELEASE_NOTES.md @@ -0,0 +1,41 @@ +# Release Description + +## Added Docker Build and Push Automation + +This release introduces a new build and push script to streamline the Docker image creation and publishing process for the `rbvtopudding/gitea-act_runner` image. + +### New Features + +**`build-and-push.sh` - Automated Build and Push Script** +- Automated Docker image build process for `rbvtopudding/gitea-act_runner` +- Automatic push to Docker Hub after successful build +- Flexible tagging support (defaults to `latest` if no tag specified) +- Error handling with `set -euo pipefail` for robust execution +- Progress messages for build and push operations + +### Usage + +**Manual Execution:** +```bash +# Build and push with default "latest" tag +./build-and-push.sh + +# Build and push with specific tag +./build-and-push.sh v1.0.0 +``` + +**Automated via Gitea Workflow:** +The script is integrated with the Gitea workflow (`.gitea/workflows/build-and-push.yaml`) and will automatically build and push images when releases are published, using the release tag as the Docker image tag. + +### What's Built + +The Docker image is based on `gitea/act_runner:latest` with the following additional packages: +- `nodejs` - JavaScript runtime +- `npm` - Node package manager +- `docker` - Docker CLI + +### Requirements + +- Docker must be installed and running +- Must be logged into Docker Hub (`docker login`) before running the script +