@@ -41,6 +41,8 @@ This action supports three tag levels for flexible versioning:
4141- ` vX.Y.Z ` : fixed to a specific release (e.g., ` v1.2.3 ` ).
4242
4343
44+
45+
4446## 📖 API Reference
4547``` yaml
4648 - name : Run the action
@@ -123,3 +125,32 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
123125If you have any questions or need help, please :
124126- 📝 Create an [issue](https://github.com/devops-infra/action-terraform-copy-vars/issues)
125127- 🌟 Star this repository if you find it useful!
128+
129+ # # Forking
130+ To publish images from a fork, set these variables so Task uses your registry identities :
131+ ` DOCKER_USERNAME` , `DOCKER_ORG_NAME`, `GITHUB_USERNAME`, `GITHUB_ORG_NAME`.
132+
133+ Two supported options (environment variables take precedence over `.env`) :
134+ ` ` ` bash
135+ # .env (local only, not committed)
136+ DOCKER_USERNAME=your-dockerhub-user
137+ DOCKER_ORG_NAME=your-dockerhub-org
138+ GITHUB_USERNAME=your-github-user
139+ GITHUB_ORG_NAME=your-github-org
140+ ` ` `
141+
142+ ` ` ` bash
143+ # Shell override
144+ DOCKER_USERNAME=your-dockerhub-user \
145+ DOCKER_ORG_NAME=your-dockerhub-org \
146+ GITHUB_USERNAME=your-github-user \
147+ GITHUB_ORG_NAME=your-github-org \
148+ task docker:build
149+ ` ` `
150+
151+ Recommended setup :
152+ - Local development : use a `.env` file.
153+ - GitHub Actions : set repo variables for the four values above, and secrets for `DOCKER_TOKEN` and `GITHUB_TOKEN`.
154+
155+ Publish images without a release :
156+ - Run the `(Manual) Update Version` workflow with `build_only : true` to build and push images without tagging a release.
0 commit comments