@@ -43,6 +43,8 @@ This action supports three tag levels for flexible versioning:
4343- ` vX.Y.Z ` : fixed to a specific release (e.g., ` v1.2.3 ` ).
4444
4545
46+
47+
4648## 📖 API Reference
4749
4850``` yaml
@@ -262,3 +264,32 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
262264If you have any questions or need help, please :
263265- 📝 Create an [issue](https://github.com/devops-infra/action-commit-push/issues)
264266- 🌟 Star this repository if you find it useful!
267+
268+ # # Forking
269+ To publish images from a fork, set these variables so Task uses your registry identities :
270+ ` DOCKER_USERNAME` , `DOCKER_ORG_NAME`, `GITHUB_USERNAME`, `GITHUB_ORG_NAME`.
271+
272+ Two supported options (environment variables take precedence over `.env`) :
273+ ` ` ` bash
274+ # .env (local only, not committed)
275+ DOCKER_USERNAME=your-dockerhub-user
276+ DOCKER_ORG_NAME=your-dockerhub-org
277+ GITHUB_USERNAME=your-github-user
278+ GITHUB_ORG_NAME=your-github-org
279+ ` ` `
280+
281+ ` ` ` bash
282+ # Shell override
283+ DOCKER_USERNAME=your-dockerhub-user \
284+ DOCKER_ORG_NAME=your-dockerhub-org \
285+ GITHUB_USERNAME=your-github-user \
286+ GITHUB_ORG_NAME=your-github-org \
287+ task docker:build
288+ ` ` `
289+
290+ Recommended setup :
291+ - Local development : use a `.env` file.
292+ - GitHub Actions : set repo variables for the four values above, and secrets for `DOCKER_TOKEN` and `GITHUB_TOKEN`.
293+
294+ Publish images without a release :
295+ - Run the `(Manual) Update Version` workflow with `build_only : true` to build and push images without tagging a release.
0 commit comments