feat: add Docker Hub description update functionality

- Introduced a new input parameter `dockerhub_description_path` in the deploy-tag workflow to specify the path for the Docker Hub description update.
- Added a new step in the workflow to utilize the `peter-evans/dockerhub-description` action for updating the Docker Hub description using the specified README file.
- Created a new `dev.md` file to outline a todo list for future enhancements and changes related to the project.

Author: sinlov

.github/workflows/deploy-tag.yml

@@ -29,6 +29,12 @@ on:
         required: false
         type: string
 
+      dockerhub_description_path:
+        description: 'dockerhub description update path'
+        default: 'README.md'
+        required: false
+        type: string
+
 permissions: # https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#permissions
   contents: write
   discussions: write
@@ -76,3 +82,12 @@ jobs:
           #   **/*.zip
           #   **/*.tar.gz
           #   **/*.sha256
+
+      - name: Docker Hub Description
+        # https://github.com/marketplace/actions/docker-hub-description
+        uses: peter-evans/dockerhub-description@v5
+        with:
+          username: ${{ vars.ENV_DOCKERHUB_OWNER }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          repository: ${{ vars.ENV_DOCKERHUB_OWNER }}/${{ vars.ENV_DOCKERHUB_REPO_NAME }}
+          readme-filepath: ${{ inputs.dockerhub_description_path }}

README.md

@@ -29,72 +29,12 @@ $ sudo chmod +x /usr/local/bin/golang-project-temple-base
 $ golang-project-temple-base --help
 ```
 
-### todo-list
-
-- rename `bridgewwater/template-docker-golang-exec-build` to new github url
-- go cli repo [https://github.com/bridgewwater/golang-project-temple-base](https://github.com/bridgewwater/golang-project-temple-base)
-- rename go cli target version `GO_PKG_RELEASE_VERSION=2.1.0` (do not add prefix `v`)
-- rename go cli target GO_SRC_PATH `github.com/bridgewwater/golang-project-temple-base`
-- rename go cli target url `https://${GO_ENV_PACKAGE_NAME}.git`
-- rename go cli target Build PATH `build/${GO_ENV_ROOT_BUILD_BIN_NAME}`
-- rename go cli target exec build entrance path `cmd/golang-project-temple-base/main.go` to new
-- rename go cli target `golang-project-temple-base` to new exec tools name
-- rename go cli target build flag `-installsuffix cgo` to new
-- rename go cli target ENTRYPOINT `/bin/golang-project-temple-base`
-- rename local `INFO_TEST_BUILD_DOCKER_CONTAINER_ARGS` at Makefile
-- rename docker hub user `template-hub-user` to new org or user
-- rename docker hub `template-hub-user/template-docker-golang-exec-build` to new docker image name
-
-- rename docker repo name at `docker-bake.hcl`
-    - `template-docker-golang-exec-build` to new docker image name
-    - `image-all` to change `platforms`
-
-- use github action for this workflow push to docker hub, must add
-    - variables `ENV_DOCKERHUB_OWNER` user of docker hub
-    - variables `ENV_DOCKERHUB_REPO_NAME` repo name of docker hub
-    - add [secrets](https://github.com/bridgewwater/template-docker-golang-exec-build/settings/secrets/actions) `New repository secret` name `DOCKERHUB_TOKEN` from [hub.docker](https://hub.docker.com/settings/security)
-
-- change `DOCKER_IMAGE_PLATFORMS: linux/amd64,linux/arm64/v8` to your need [docker buildx](https://docs.docker.com/buildx/working-with-buildx/)
-  - also change `jobs.docker-image-buildx.strategy.matrix.docker_image.[platform]` same as `DOCKER_IMAGE_PLATFORMS`
-- change `push_remote_flag: ${{ github.event.pull_request.merged == true }}` to let latest tag push to docker hub
-
-
 ## source repo
 
 [https://github.com/bridgewwater/template-docker-golang-exec-build](https://github.com/bridgewwater/template-docker-golang-exec-build)
 
-### env
-
-- parent image `alpine` version `3.20.3`
-- minimum go image version: go 1.18
-- change `go 1.18`, `^1.18`, `1.18.10`, `1.18.10` to new go version
-
-### dev mode
-
-```bash
-# see help
-$ make help
-# see or check build env
-$ make env
-
-# fast build
-$ make all
-# clean build
-$ make clean
-
-# then test build as test/Dockerfile
-$ make dockerTestRestartLatest
-# clean test build
-$ make dockerTestPruneLatest
-```
-
-## Contributing
-
-[![Contributor Covenant](https://img.shields.io/badge/contributor%20covenant-v1.4-ff69b4.svg)](.github/CONTRIBUTING_DOC/CODE_OF_CONDUCT.md)
-[![GitHub contributors](https://img.shields.io/github/contributors/bridgewwater/template-docker-golang-exec-build)](https://github.com/bridgewwater/template-docker-golang-exec-build/graphs/contributors)
-
-We welcome community contributions to this project.
 
-Please read [Contributor Guide](.github/CONTRIBUTING_DOC/CONTRIBUTING.md) for more information on how to get started.
+## features
 
-请阅读有关 [贡献者指南](.github/CONTRIBUTING_DOC/zh-CN/CONTRIBUTING.md) 以获取更多如何入门的信息
+- [ ] foo
+- [ ] bar

doc-dev/dev.md

@@ -0,0 +1,58 @@
+### todo-list
+
+- rename `bridgewwater/template-docker-golang-exec-build` to new github url
+- go cli repo [https://github.com/bridgewwater/golang-project-temple-base](https://github.com/bridgewwater/golang-project-temple-base)
+- rename go cli target version `GO_PKG_RELEASE_VERSION=2.1.0` (do not add prefix `v`)
+- rename go cli target GO_SRC_PATH `github.com/bridgewwater/golang-project-temple-base`
+- rename go cli target url `https://${GO_ENV_PACKAGE_NAME}.git`
+- rename go cli target Build PATH `build/${GO_ENV_ROOT_BUILD_BIN_NAME}`
+- rename go cli target exec build entrance path `cmd/golang-project-temple-base/main.go` to new
+- rename go cli target `golang-project-temple-base` to new exec tools name
+- rename go cli target build flag `-installsuffix cgo` to new
+- rename go cli target ENTRYPOINT `/bin/golang-project-temple-base`
+- rename local `INFO_TEST_BUILD_DOCKER_CONTAINER_ARGS` at Makefile
+- rename docker hub user `template-hub-user` to new org or user
+- rename docker hub `template-hub-user/template-docker-golang-exec-build` to new docker image name
+
+- rename docker repo name at `docker-bake.hcl`
+    - `template-docker-golang-exec-build` to new docker image name
+    - `image-all` to change `platforms`
+
+- use github action for this workflow push to docker hub, must add
+    - variables `ENV_DOCKERHUB_OWNER` user of docker hub
+    - variables `ENV_DOCKERHUB_REPO_NAME` repo name of docker hub
+    - add [secrets](https://github.com/bridgewwater/template-docker-golang-exec-build/settings/secrets/actions) `New repository secret` name `DOCKERHUB_TOKEN` from [hub.docker](https://hub.docker.com/settings/security)
+
+- change `DOCKER_IMAGE_PLATFORMS: linux/amd64,linux/arm64/v8` to your need [docker buildx](https://docs.docker.com/buildx/working-with-buildx/)
+  - also change `jobs.docker-image-buildx.strategy.matrix.docker_image.[platform]` same as `DOCKER_IMAGE_PLATFORMS`
+- change `push_remote_flag: ${{ github.event.pull_request.merged == true }}` to let latest tag push to docker hub
+
+
+## source repo
+
+[https://github.com/bridgewwater/template-docker-golang-exec-build](https://github.com/bridgewwater/template-docker-golang-exec-build)
+
+### env
+
+- parent image `alpine` version `3.20.3`
+- minimum go image version: go 1.18
+- change `go 1.18`, `^1.18`, `1.18.10`, `1.18.10` to new go version
+
+### dev mode
+
+```bash
+# see help
+$ make help
+# see or check build env
+$ make env
+
+# fast build
+$ make all
+# clean build
+$ make clean
+
+# then test build as test/Dockerfile
+$ make dockerTestRestartLatest
+# clean test build
+$ make dockerTestPruneLatest
+```