From 8a04317caa1df65498f265327140f15965bf2d64 Mon Sep 17 00:00:00 2001 From: merith-xyz Date: Tue, 1 Oct 2024 16:31:07 -0700 Subject: [PATCH] Squashed all commits into one --- Readme.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 Readme.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..2904b26 --- /dev/null +++ b/Readme.md @@ -0,0 +1,36 @@ +# README for Docker Image Build and Publish Workflows + +## Overview + +This repository contains two GitHub Actions workflows that automate the building and publishing of Docker images to an OCI registry. + +### Workflows + +1. **On Commit to Main** + - **Trigger:** Activates on commits to the `main` branch (tags are excluded). + - **Purpose:** Builds and publishes a Docker image for each commit. + +2. **On Tag Push** + - **Trigger:** Activates when a new tag is pushed. + - **Purpose:** Builds and publishes a Docker image for the tag and tags it as `latest`. + +## Prerequisites + +- **Secrets Needed:** + - `OCI_TOKEN`: Your OCI registry token. + - `OCI_USER`: Your OCI registry username. + +## How to Use + +1. **Clone the Repository:** Get a local copy of this repository. +2. **Modify Dockerfile:** Update the `Dockerfile` for your application. +3. **Push Changes:** Push changes to the `main` branch or create a new tag. +4. **Check Workflow Status:** View the Actions tab in Forgjo to monitor workflow runs. + +## Notes + +- Ensure your Docker environment is compatible with multi-platform builds if necessary. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. \ No newline at end of file