@@ -35,6 +35,8 @@ This action supports three tag levels for flexible versioning:
3535- ` vX.Y.Z ` : fixed to a specific release (e.g., ` v1.2.3 ` ).
3636
3737
38+
39+
3840## 📖 API Reference
3941``` yaml
4042 - name : Run the Action
@@ -133,3 +135,32 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
133135If you have any questions or need help, please :
134136- 📝 Create an [issue](https://github.com/devops-infra/action-tflint/issues)
135137- 🌟 Star this repository if you find it useful!
138+
139+ # # Forking
140+ To publish images from a fork, set these variables so Task uses your registry identities :
141+ ` DOCKER_USERNAME` , `DOCKER_ORG_NAME`, `GITHUB_USERNAME`, `GITHUB_ORG_NAME`.
142+
143+ Two supported options (environment variables take precedence over `.env`) :
144+ ` ` ` bash
145+ # .env (local only, not committed)
146+ DOCKER_USERNAME=your-dockerhub-user
147+ DOCKER_ORG_NAME=your-dockerhub-org
148+ GITHUB_USERNAME=your-github-user
149+ GITHUB_ORG_NAME=your-github-org
150+ ` ` `
151+
152+ ` ` ` bash
153+ # Shell override
154+ DOCKER_USERNAME=your-dockerhub-user \
155+ DOCKER_ORG_NAME=your-dockerhub-org \
156+ GITHUB_USERNAME=your-github-user \
157+ GITHUB_ORG_NAME=your-github-org \
158+ task docker:build
159+ ` ` `
160+
161+ Recommended setup :
162+ - Local development : use a `.env` file.
163+ - GitHub Actions : set repo variables for the four values above, and secrets for `DOCKER_TOKEN` and `GITHUB_TOKEN`.
164+
165+ Publish images without a release :
166+ - Run the `(Manual) Update Version` workflow with `build_only : true` to build and push images without tagging a release.
0 commit comments