From 970a22ff3e7c160720fa544e9ed752a306a4d2db Mon Sep 17 00:00:00 2001 From: accetto <34798830+accetto@users.noreply.github.com> Date: Mon, 24 Oct 2022 09:53:50 +0200 Subject: [PATCH] Release 22.10 - the last G3v1 release --- .dockerignore | 13 ------------- .github/workflows/deploy-readme.sh | 2 ++ .github/workflows/dockerhub-autobuild.yml | 3 +++ .github/workflows/dockerhub-post-push.yml | 3 +++ .gitignore | 5 ++++- CHANGELOG.md | 6 ++++++ docker/.dockerignore | 4 ++++ docker/hooks/env.rc | 14 +++++++++++++- docker/hooks/post_push | 2 ++ docker/hooks/push | 3 +++ docker/hooks/util.rc | 1 + docker/src/examples/example-secrets.rc | 4 ++++ local-building-example.md | 2 ++ utils/example-secrets-utils.rc | 4 +++- utils/examples-util-readme.md | 2 ++ utils/util-readme.sh | 2 ++ 16 files changed, 54 insertions(+), 16 deletions(-) delete mode 100644 .dockerignore create mode 100644 docker/.dockerignore diff --git a/.dockerignore b/.dockerignore deleted file mode 100644 index e7a9186..0000000 --- a/.dockerignore +++ /dev/null @@ -1,13 +0,0 @@ -* -!src -.debugger* -.developer* -.secrets* -*.log -*.md -*.sh -avanti* -debug* -secret* -scrap* -TODO* diff --git a/.github/workflows/deploy-readme.sh b/.github/workflows/deploy-readme.sh index 62bb8c0..af118d3 100644 --- a/.github/workflows/deploy-readme.sh +++ b/.github/workflows/deploy-readme.sh @@ -6,6 +6,8 @@ ### However, you can always copy the content generated by the utility ### 'util-readme.sh' ('preview' command) to the Docker Hub manually. +# DEPRECATED: This script is deprecated and it will be removed or replaced. + main() { local repo="${1?Need repo}" local gist="${2?Need gist}" diff --git a/.github/workflows/dockerhub-autobuild.yml b/.github/workflows/dockerhub-autobuild.yml index ff9161f..949d644 100644 --- a/.github/workflows/dockerhub-autobuild.yml +++ b/.github/workflows/dockerhub-autobuild.yml @@ -1,3 +1,6 @@ + +### DEPRECATED: This file is deprecated and it will be removed. + ### This workflow triggers auto-building on Docker Hub. name: dockerhub-autobuild on: diff --git a/.github/workflows/dockerhub-post-push.yml b/.github/workflows/dockerhub-post-push.yml index fb81a95..6241a3b 100644 --- a/.github/workflows/dockerhub-post-push.yml +++ b/.github/workflows/dockerhub-post-push.yml @@ -1,3 +1,6 @@ + +### DEPRECATED: This file is deprecated and it will be removed. + ### This workflow can be optionally triggered by Docker Hub after pushing an image. name: dockerhub-post-push on: diff --git a/.gitignore b/.gitignore index 4f1b1f0..f42aa63 100644 --- a/.gitignore +++ b/.gitignore @@ -14,10 +14,13 @@ .vscode .debugger* .developer* -.secrets* +.secret* +.vscode *.log avanti* debug* scrap* secret* TODO* +.favorites.json +*cache* diff --git a/CHANGELOG.md b/CHANGELOG.md index 134b94f..f5a6f6b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,12 @@ *** +### Release 22.10 + +This is the last release of the current building pipeline generation `G3v1`, which will still be available in the repository as the branch `archived-generation-g3v1`. + +The next milestone release will bring some significant changes and improvements in the building pipeline (generation `G3v2`) . The changing parts marked as `DEPRECATED` will be replaced or removed. + ### Release 22.09 This is just a maintenance release. diff --git a/docker/.dockerignore b/docker/.dockerignore new file mode 100644 index 0000000..e3f8ac3 --- /dev/null +++ b/docker/.dockerignore @@ -0,0 +1,4 @@ +* +!src +!xfce* +!.g3-cache diff --git a/docker/hooks/env.rc b/docker/hooks/env.rc index 5172148..8a8e665 100644 --- a/docker/hooks/env.rc +++ b/docker/hooks/env.rc @@ -1,5 +1,9 @@ ### All variables in capitals can be set also by environment. +# DEPRECATED: Building on Docker Hub is deprecated and it will be removed. +# DEPRECATED: GitHub Actions workflows are deprecated and they will be removed. +# DEPRECATED: README publishing is deprecated and it will be removed. + ### build context is the path to the Dockerfile ### it is expected that '_mydir' is already set by the calling script declare _build_context="$(dirname ${_mydir})" @@ -11,16 +15,23 @@ declare _branch="${SOURCE_BRANCH:-$1}" ### which image variation to build (feature blend) declare _blend="${DOCKER_TAG:-$2}" -### building stage +### building stage +# DEPRECATED: The variable '_stage' is deprecated and it will be removed. declare _stage ### owner of the builder and deployment repositories must be the same declare _owner +# DEPRECATED: This 'if' block is deprecated and it will be replaced. if [ $# -ge 2 ] ; then shift 2 _stage="local" + + ### you can change the local owner if you only want to build locally and you don't need + ### to compare the verbose version sticker against the value from the builder GitHub Gist + ### (as it's implemented in the 'pre_build' hook script) + # _owner="dev" _owner="accetto" ### supporting local testing of the complete CI workflow @@ -56,6 +67,7 @@ declare _deploytag declare _readme_context ### GitHub repo and branch containing the post_push workflow to trigger +# DEPRECATED: Variables 'POST_PUSH_WORKFLOW_REPO' and 'POST_PUSH_WORKFLOW_BRANCH' are deprecated and will be removed. POST_PUSH_WORKFLOW_REPO=${POST_PUSH_WORKFLOW_REPO:-"headless-coding-g3"} POST_PUSH_WORKFLOW_BRANCH=${POST_PUSH_WORKFLOW_BRANCH:-"master"} diff --git a/docker/hooks/post_push b/docker/hooks/post_push index b174f18..0cb970b 100644 --- a/docker/hooks/post_push +++ b/docker/hooks/post_push @@ -25,6 +25,7 @@ main() { if [ -f "${_build_context}/${_scrap_demand_stop_building}" ] ; then + # DEPRECATED: This 'if' block is deprecated and it will be removed from the future releases. if [ "${FORCE_README_PUBLISHING}" != "1" ] ; then echo "Skipping post_push on demand." @@ -77,6 +78,7 @@ main() { ### trigger the GitHub Actions workflow to push the readme file into the deployment repository ### essential environment variables must be already set + # DEPRECATED: This 'if' block is deprecated and it will be removed from the future releases. if [ -n "${POST_PUSH_WORKFLOW_BRANCH}" ] && [ -n "${POST_PUSH_WORKFLOW_TOKEN}" ] && [ "${PROHIBIT_README_PUBLISHING}" != "1" ] ; then ### 'git branch --show-current' helps by testing local building diff --git a/docker/hooks/push b/docker/hooks/push index 5c3f37a..6827cf5 100644 --- a/docker/hooks/push +++ b/docker/hooks/push @@ -37,6 +37,7 @@ main() { return 0 fi + # DEPRECATED: This if block is deprecated and it will be replaced. if [ "${_stage}" == "local" ] ; then if [ -n "${DOCKERHUB_USERNAME}" ] && [ -n "${DOCKERHUB_PASSWORD}" ] ; then @@ -53,12 +54,14 @@ main() { fi fi + # DEPRECATED: This if block is deprecated and it will be replaced. ### push image into the builder repository if [ "${_stage}" != "local" ] ; then builder_push ; fi ### push images into the deployment repository deployment_push + # DEPRECATED: This if block is deprecated and it will be replaced. if [ "${_stage}" == "local" ] ; then docker logout ; fi } diff --git a/docker/hooks/util.rc b/docker/hooks/util.rc index 4dab1ae..ac35d46 100644 --- a/docker/hooks/util.rc +++ b/docker/hooks/util.rc @@ -197,6 +197,7 @@ update_gist() { fi } +# DEPRECATED This procedure is deprecated and it will be removed. trigger_post_push_workflow() { ### Trigger the 'post_push' workflow on GitHub. ### Secret 'POST_PUSH_WORKFLOW_TOKEN' with the scopes 'repo' and 'workflow' is needed. diff --git a/docker/src/examples/example-secrets.rc b/docker/src/examples/example-secrets.rc index 59707d8..5dec4f1 100644 --- a/docker/src/examples/example-secrets.rc +++ b/docker/src/examples/example-secrets.rc @@ -26,6 +26,7 @@ export DOCKER_BUILDKIT=1 ### optional on Docker Hub ### will force README re-publishing regardless of verbose version sticker changes +### DEPRECATED: Variable 'FORCE_README_PUBLISHING' is deprecated and it will be removed. # export FORCE_README_PUBLISHING=0 ### optional on Docker Hub @@ -33,13 +34,16 @@ export DOCKER_BUILDKIT=1 ### useful for testing on Docker Hub or by building from non-master branches ### ATTENTION: Docker Hub removed aut-building from the free plans since 2021-07-26, so prohibit ### the post-push workflow execution and publish the readme using the provided utility +### DEPRECATED: Variable 'FORCE_README_PUBLISHING' is deprecated and it will be removed. export PROHIBIT_README_PUBLISHING=1 ### optional on Docker Hub ### GitHub repo and branch containing the post_push workflow to trigger # export POST_PUSH_WORKFLOW_REPO="headless-coding-g3" # export POST_PUSH_WORKFLOW_BRANCH="master" +### DEPRECATED: Variable 'FORCE_README_PUBLISHING' is deprecated and it will be removed. export POST_PUSH_WORKFLOW_REPO="" +### DEPRECATED: Variable 'FORCE_README_PUBLISHING' is deprecated and it will be removed. export POST_PUSH_WORKFLOW_BRANCH="" ### required on Docker Hub diff --git a/local-building-example.md b/local-building-example.md index 8d87606..516db7a 100644 --- a/local-building-example.md +++ b/local-building-example.md @@ -117,6 +117,8 @@ This step updates the GitHub Gists and removes the temporary helper files create **Remark**: If this script would be executed on Docker Hub, then it would also publish the readme file. However, it doesn't work correctly by local building. Therefore it's recommended to set the environment variable `PROHIBIT_README_PUBLISHING=1`. You can do it also in the secrets file. +DEPRECATED: Note that the environment variable `PROHIBIT_README_PUBLISHING` and also the whole automatic README publishing have been deprecated and they will be removed. + ### Step 5: `util-readme.sh` This step updates the `README` file and publishes it on Docker Hub. diff --git a/utils/example-secrets-utils.rc b/utils/example-secrets-utils.rc index a5cfb2f..1326ea3 100644 --- a/utils/example-secrets-utils.rc +++ b/utils/example-secrets-utils.rc @@ -1,4 +1,6 @@ -### This files configures the environment (including secrets!) for utilities used locally. +# DEPRECATED: This file is deprecated and it will be removed. + +### This file configures the environment (including secrets!) for utilities used locally. ### The utility scripts will source this file themselves. You do not need this file on Docker Hub. ### Rename the file to "secrets-utils.rc" (or similar) and **make sure** that the '.gitignore' and '.dockerignore' files ### contain the 'secret*' exclusion pattern! diff --git a/utils/examples-util-readme.md b/utils/examples-util-readme.md index c20c76f..637cdc7 100644 --- a/utils/examples-util-readme.md +++ b/utils/examples-util-readme.md @@ -8,6 +8,8 @@ Updated: 2022-09-11 It seems like the `publish` command is currently not always working. Some changes on the **Docker Hub** side seem to be the reason. However, you can always copy the content generated by the `preview` command (`scrap-readme.md`) to the **Docker Hub** manually. +DEPRECATED: The 'publish' command is deprecated and it will be removed or replaced. + *** ## Preparation diff --git a/utils/util-readme.sh b/utils/util-readme.sh index 214783c..71d35b2 100644 --- a/utils/util-readme.sh +++ b/utils/util-readme.sh @@ -6,6 +6,8 @@ ### However, you can always copy the content generated by the 'preview' ### command (scrap-readme.md) to the Docker Hub manually. +### DEPRECATED: The 'publish' command is deprecated and it will be removed or replaced. + ### @accetto, December 2020 ### https://github.com/accetto/ubuntu-vnc-xfce-g3 ### https://github.com/accetto/ubuntu-vnc-xfce-g3/wiki