From fee3137bd5c0881b4052aa86f926abdd0ba30c4b Mon Sep 17 00:00:00 2001 From: dimzrio Date: Thu, 18 May 2023 15:27:34 +0700 Subject: [PATCH 01/10] Add documentation for build frontned --- build/frontend/README.md | 51 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 build/frontend/README.md diff --git a/build/frontend/README.md b/build/frontend/README.md new file mode 100644 index 00000000..c530f544 --- /dev/null +++ b/build/frontend/README.md @@ -0,0 +1,51 @@ + +## Description + +Frontend composite deployment + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| install | Run make install | `false` | true | +| config | Run make config | `false` | true | +| build | Run make build | `false` | true | +| package | Run make package | `false` | true | +| cache | Run action cache | `false` | true | +| project_id | GCP project id | `true` | | +| credentials_json | GCP credentials services account | `true` | | +| gcr_host | GCP container registry host | `true` | | +| setup_pnpm | Setup pnpm and cache modules | `false` | false | +| setup_yarn | Setup yarn and cache modules | `false` | false | +| chartmuseum_host | ChartMuseum host | `true` | | +| chartmuseum_user | ChartMuseum user | `true` | | +| chartmuseum_pass | ChartMuseum password | `true` | | +| working_directory | Set working directory | `false` | . | +| pnpm_version | Setup pnpm version | `false` | latest | +| using_nextjs | Setup next.js cache modules | `false` | false | +| using_cdn | Setup cdn for static assets | `false` | false | +| delete_oldest_cdn | Setup delete oldest cdn | `false` | true | +| cdn_aws_s3_bucket | CDN aws s3 bucket | `false` | | +| cdn_aws_access_key_id | CDN aws access key id | `false` | | +| cdn_aws_secret_access_key | CDN aws secret access key | `false` | | +| cdn_aws_region | CDN aws region | `false` | | +| cdn_source_dir | CDN source dir | `false` | | +| cdn_dest_dir | CDN dest dir | `false` | | +| cdn_keep_latest_version | CDN keep latest version length | `false` | 2 | + + + +## Outputs + +| parameter | description | +| --- | --- | +| build-time | Define build time | + + + +## Runs + +This action is a `composite` action. + From 2934b3b3aa4a3574015ac95d279b59a520812b46 Mon Sep 17 00:00:00 2001 From: dimzrio Date: Thu, 18 May 2023 16:15:15 +0700 Subject: [PATCH 02/10] Add readme --- build/backend/README.md | 7 +++ build/frontend/README.md | 44 ------------------- build/static/README.md | 7 +++ deploy/ansible/README.md | 7 +++ deploy/backend/README.md | 7 +++ deploy/frontend/README.md | 7 +++ deploy/terragrunt/README.md | 7 +++ destroy/README.md | 7 +++ generate.sh | 11 +++++ packages/buildx/README.md | 7 +++ packages/cdn/README.md | 7 +++ packages/gcloud/README.md | 7 +++ packages/gke-credential/README.md | 7 +++ packages/makefile/README.md | 7 +++ packages/pnpm/README.md | 7 +++ packages/rancher/README.md | 7 +++ packages/swagger/README.md | 7 +++ packages/yarn/README.md | 7 +++ rollback/README.md | 7 +++ tools/frontend/lighthouse/README.md | 7 +++ .../frontend/nextjs-bundle-analysis/README.md | 7 +++ unit_test/backend/README.md | 33 ++------------ 22 files changed, 148 insertions(+), 73 deletions(-) create mode 100644 build/backend/README.md create mode 100644 build/static/README.md create mode 100644 deploy/ansible/README.md create mode 100644 deploy/backend/README.md create mode 100644 deploy/frontend/README.md create mode 100644 deploy/terragrunt/README.md create mode 100644 destroy/README.md create mode 100755 generate.sh create mode 100644 packages/buildx/README.md create mode 100644 packages/cdn/README.md create mode 100644 packages/gcloud/README.md create mode 100644 packages/gke-credential/README.md create mode 100644 packages/makefile/README.md create mode 100644 packages/pnpm/README.md create mode 100644 packages/rancher/README.md create mode 100644 packages/swagger/README.md create mode 100644 packages/yarn/README.md create mode 100644 rollback/README.md create mode 100644 tools/frontend/lighthouse/README.md create mode 100644 tools/frontend/nextjs-bundle-analysis/README.md diff --git a/build/backend/README.md b/build/backend/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/build/backend/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/build/frontend/README.md b/build/frontend/README.md index c530f544..d805e25a 100644 --- a/build/frontend/README.md +++ b/build/frontend/README.md @@ -1,51 +1,7 @@ -## Description -Frontend composite deployment - - - -## Inputs - -| parameter | description | required | default | -| --- | --- | --- | --- | -| install | Run make install | `false` | true | -| config | Run make config | `false` | true | -| build | Run make build | `false` | true | -| package | Run make package | `false` | true | -| cache | Run action cache | `false` | true | -| project_id | GCP project id | `true` | | -| credentials_json | GCP credentials services account | `true` | | -| gcr_host | GCP container registry host | `true` | | -| setup_pnpm | Setup pnpm and cache modules | `false` | false | -| setup_yarn | Setup yarn and cache modules | `false` | false | -| chartmuseum_host | ChartMuseum host | `true` | | -| chartmuseum_user | ChartMuseum user | `true` | | -| chartmuseum_pass | ChartMuseum password | `true` | | -| working_directory | Set working directory | `false` | . | -| pnpm_version | Setup pnpm version | `false` | latest | -| using_nextjs | Setup next.js cache modules | `false` | false | -| using_cdn | Setup cdn for static assets | `false` | false | -| delete_oldest_cdn | Setup delete oldest cdn | `false` | true | -| cdn_aws_s3_bucket | CDN aws s3 bucket | `false` | | -| cdn_aws_access_key_id | CDN aws access key id | `false` | | -| cdn_aws_secret_access_key | CDN aws secret access key | `false` | | -| cdn_aws_region | CDN aws region | `false` | | -| cdn_source_dir | CDN source dir | `false` | | -| cdn_dest_dir | CDN dest dir | `false` | | -| cdn_keep_latest_version | CDN keep latest version length | `false` | 2 | -## Outputs - -| parameter | description | -| --- | --- | -| build-time | Define build time | - - - -## Runs -This action is a `composite` action. diff --git a/build/static/README.md b/build/static/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/build/static/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/deploy/ansible/README.md b/deploy/ansible/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/deploy/ansible/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/deploy/backend/README.md b/deploy/backend/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/deploy/backend/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/deploy/frontend/README.md b/deploy/frontend/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/deploy/frontend/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/deploy/terragrunt/README.md b/deploy/terragrunt/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/deploy/terragrunt/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/destroy/README.md b/destroy/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/destroy/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/generate.sh b/generate.sh new file mode 100755 index 00000000..cc2b3b71 --- /dev/null +++ b/generate.sh @@ -0,0 +1,11 @@ +for i in `find . -name action.yaml | sed 's|/[^/]*$||'`; do + cat <$i/README.md + + + + + + + +EOF +done diff --git a/packages/buildx/README.md b/packages/buildx/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/packages/buildx/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/packages/cdn/README.md b/packages/cdn/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/packages/cdn/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/packages/gcloud/README.md b/packages/gcloud/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/packages/gcloud/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/packages/gke-credential/README.md b/packages/gke-credential/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/packages/gke-credential/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/packages/makefile/README.md b/packages/makefile/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/packages/makefile/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/packages/pnpm/README.md b/packages/pnpm/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/packages/pnpm/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/packages/rancher/README.md b/packages/rancher/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/packages/rancher/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/packages/swagger/README.md b/packages/swagger/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/packages/swagger/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/packages/yarn/README.md b/packages/yarn/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/packages/yarn/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/rollback/README.md b/rollback/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/rollback/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/tools/frontend/lighthouse/README.md b/tools/frontend/lighthouse/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/tools/frontend/lighthouse/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/tools/frontend/nextjs-bundle-analysis/README.md b/tools/frontend/nextjs-bundle-analysis/README.md new file mode 100644 index 00000000..d805e25a --- /dev/null +++ b/tools/frontend/nextjs-bundle-analysis/README.md @@ -0,0 +1,7 @@ + + + + + + + diff --git a/unit_test/backend/README.md b/unit_test/backend/README.md index 6f99a28a..d805e25a 100644 --- a/unit_test/backend/README.md +++ b/unit_test/backend/README.md @@ -1,32 +1,7 @@ -# How to use this composite action -Example of usage: -``` -name: Test Coverage -on: - pull_request: - branches: - - master + -jobs: - test-coverage: - if: ${{ !github.event.pull_request.draft }} - runs-on: ktbs-infra-k8s-runner - steps: - - name: Test Coverage - uses: kitabisa/composite-actions/unit_test/backend@878932e5ea13a1db81014c8b27635d21c69f2b96 - with: - gh_user: ${{ secrets.GH_USER }} - gh_token: ${{ secrets.GH_TOKEN }} - cache: true - cache_dependency_path: go.sum - go_version: 1.19 - custom_command_flag: true - custom_command: "cp ./params/.env.sample ./params/.env" - need_mockery: true + -``` + -Parameters that you can configure -- custom_command_flag: by default is false, set to true if you have custom command for unit test -- custom_command: custom command that you want to run for executing unit test. For example, our unit test need to use `.env` so we have to copy `.env.sample` -- need_mockery: by default is false, set to true if you need mockery for unit test (e.g you want to re-generate mock before running UT) + From 2c2ae0a043320806c604e7342b99c30fd1a06165 Mon Sep 17 00:00:00 2001 From: dimzrio Date: Thu, 18 May 2023 16:19:35 +0700 Subject: [PATCH 03/10] Generate action readme --- build/backend/README.md | 30 +++++++++++++ build/frontend/README.md | 44 +++++++++++++++++++ build/static/README.md | 22 ++++++++++ deploy/ansible/README.md | 18 ++++++++ deploy/backend/README.md | 30 +++++++++++++ deploy/frontend/README.md | 30 +++++++++++++ deploy/terragrunt/README.md | 19 ++++++++ destroy/README.md | 28 ++++++++++++ generate.sh | 5 ++- packages/buildx/README.md | 18 ++++++++ packages/cdn/README.md | 23 ++++++++++ packages/gcloud/README.md | 17 +++++++ packages/gke-credential/README.md | 18 ++++++++ packages/makefile/README.md | 41 +++++++++++++++++ packages/pnpm/README.md | 19 ++++++++ packages/rancher/README.md | 20 +++++++++ packages/swagger/README.md | 20 +++++++++ packages/yarn/README.md | 18 ++++++++ rollback/README.md | 21 +++++++++ tools/frontend/lighthouse/README.md | 20 +++++++++ .../frontend/nextjs-bundle-analysis/README.md | 20 +++++++++ unit_test/backend/README.md | 24 ++++++++++ 22 files changed, 504 insertions(+), 1 deletion(-) diff --git a/build/backend/README.md b/build/backend/README.md index d805e25a..4b444684 100644 --- a/build/backend/README.md +++ b/build/backend/README.md @@ -1,7 +1,37 @@ +## Description +Build and push docker image + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| gh_user | gh user | `true` | | +| gh_token | gh token | `true` | | +| cache_dependency_path | go sum location | `false` | go.sum | +| go_version | go version | `false` | ^1.13.1 | +| build | Run make build | `false` | true | +| build_push_image | build and push image for deployment | `false` | false | +| build_push_image_swagger | build and push image for swagger | `false` | false | +| build_push_image_mockoon | build and push image for mockoon | `false` | | +| credentials_json | GCP credentials services account | `false` | | +| project_id | GCP project id | `false` | | +| gcr_host | GCP container registry host | `false` | | +| swagger_script_path | swagger script path | `false` | | +| openapi_input_file | openapi input file | `false` | | +| openapi_output_file | openapi output file | `false` | | +| working_directory | Set working directory | `false` | . | + + + +## Runs + +This action is a `composite` action. diff --git a/build/frontend/README.md b/build/frontend/README.md index d805e25a..c530f544 100644 --- a/build/frontend/README.md +++ b/build/frontend/README.md @@ -1,7 +1,51 @@ +## Description +Frontend composite deployment + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| install | Run make install | `false` | true | +| config | Run make config | `false` | true | +| build | Run make build | `false` | true | +| package | Run make package | `false` | true | +| cache | Run action cache | `false` | true | +| project_id | GCP project id | `true` | | +| credentials_json | GCP credentials services account | `true` | | +| gcr_host | GCP container registry host | `true` | | +| setup_pnpm | Setup pnpm and cache modules | `false` | false | +| setup_yarn | Setup yarn and cache modules | `false` | false | +| chartmuseum_host | ChartMuseum host | `true` | | +| chartmuseum_user | ChartMuseum user | `true` | | +| chartmuseum_pass | ChartMuseum password | `true` | | +| working_directory | Set working directory | `false` | . | +| pnpm_version | Setup pnpm version | `false` | latest | +| using_nextjs | Setup next.js cache modules | `false` | false | +| using_cdn | Setup cdn for static assets | `false` | false | +| delete_oldest_cdn | Setup delete oldest cdn | `false` | true | +| cdn_aws_s3_bucket | CDN aws s3 bucket | `false` | | +| cdn_aws_access_key_id | CDN aws access key id | `false` | | +| cdn_aws_secret_access_key | CDN aws secret access key | `false` | | +| cdn_aws_region | CDN aws region | `false` | | +| cdn_source_dir | CDN source dir | `false` | | +| cdn_dest_dir | CDN dest dir | `false` | | +| cdn_keep_latest_version | CDN keep latest version length | `false` | 2 | +## Outputs + +| parameter | description | +| --- | --- | +| build-time | Define build time | + + + +## Runs +This action is a `composite` action. diff --git a/build/static/README.md b/build/static/README.md index d805e25a..23368b7a 100644 --- a/build/static/README.md +++ b/build/static/README.md @@ -1,7 +1,29 @@ +## Description +Static web composite deployment + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| project_id | GCP project id | `true` | | +| credentials_json | GCP credentials services account | `true` | | +| gcr_host | GCP container registry host | `true` | | +| chartmuseum_host | ChartMuseum host | `true` | | +| chartmuseum_user | ChartMuseum user | `true` | | +| chartmuseum_pass | ChartMuseum password | `true` | | +| working_directory | Set working directory | `false` | . | + + + +## Runs + +This action is a `composite` action. diff --git a/deploy/ansible/README.md b/deploy/ansible/README.md index d805e25a..a785bf70 100644 --- a/deploy/ansible/README.md +++ b/deploy/ansible/README.md @@ -1,7 +1,25 @@ +## Description +Run Ansible Playbooks + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| path | Ansible Playbook path | `true` | | +| ssh_private_key | SSH Private Key | `true` | | +| vault_password | Vault password | `false` | | + + + +## Runs + +This action is a `composite` action. diff --git a/deploy/backend/README.md b/deploy/backend/README.md index d805e25a..e18352ea 100644 --- a/deploy/backend/README.md +++ b/deploy/backend/README.md @@ -1,7 +1,37 @@ +## Description +Build and push docker image + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| env | environment to deploy to | `true` | dev | +| gh_token | gh token | `true` | | +| project_id | GCP project id | `true` | | +| gcr_host | GCP container registry host | `true` | | +| chartmuseum_host | ChartMuseum host | `true` | | +| chartmuseum_user | ChartMuseum user | `true` | | +| chartmuseum_pass | ChartMuseum password | `true` | | +| gke_cluster_name | GKE cluster name | `true` | | +| gke_cluster_zone | GKE cluster location zone | `true` | | +| rancher_host | Rancher host | `true` | | +| rancher_access_key | Rancher access key | `true` | | +| rancher_secret_key | Rancher secret key | `true` | | +| rancher_cluster_id | Rancher cluster id | `true` | | +| working_directory | Set working directory | `false` | . | +| setup_helmfiles | Setup helmfiles | `false` | false | + + + +## Runs + +This action is a `composite` action. diff --git a/deploy/frontend/README.md b/deploy/frontend/README.md index d805e25a..6c0afb50 100644 --- a/deploy/frontend/README.md +++ b/deploy/frontend/README.md @@ -1,7 +1,37 @@ +## Description +Frontend composite deployment + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| project_id | GCP project id | `true` | | +| credentials_json | GCP credentials services account | `true` | | +| gcr_host | GCP container registry host | `true` | | +| chartmuseum_host | ChartMuseum host | `true` | | +| chartmuseum_user | ChartMuseum user | `true` | | +| chartmuseum_pass | ChartMuseum password | `true` | | +| gke_cluster_name | GKE cluster name | `true` | | +| gke_cluster_zone | GKE cluster location zone | `true` | | +| rancher_host | Rancher host | `true` | | +| rancher_access_key | Rancher access key | `true` | | +| rancher_secret_key | Rancher secret key | `true` | | +| rancher_cluster_id | Rancher cluster id | `true` | | +| working_directory | Set working directory | `false` | . | +| preview_url | Set preview url | `false` | | +| prune | Run make prune | `false` | false | + + + +## Runs + +This action is a `composite` action. diff --git a/deploy/terragrunt/README.md b/deploy/terragrunt/README.md index d805e25a..dc33ab68 100644 --- a/deploy/terragrunt/README.md +++ b/deploy/terragrunt/README.md @@ -1,7 +1,26 @@ +## Description +Run Terragrunt Plan & Apply + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| path | Terragrunt path | `true` | | +| git_user | Git login user | `true` | | +| git_token | Git token access | `true` | | +| gcp_credentials | GCP credentials | `false` | | + + + +## Runs + +This action is a `composite` action. diff --git a/destroy/README.md b/destroy/README.md index d805e25a..c338aa51 100644 --- a/destroy/README.md +++ b/destroy/README.md @@ -1,7 +1,35 @@ +## Description +Destroy release deployment + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| working_directory | Set working directory | `false` | . | +| credentials_json | GCP credentials services account | `true` | | +| gke_cluster_name | GKE cluster name | `true` | | +| gke_cluster_zone | GKE cluster location zone | `true` | | +| gcr_host | GCP container registry host | `true` | | +| project_id | GCP project id | `true` | | +| prune_all | make prune-all | `false` | false | +| using_cdn | Setup cdn for static assets | `false` | false | +| delete_oldest_cdn | Setup delete oldest cdn | `false` | true | +| cdn_aws_s3_bucket | CDN aws s3 bucket | `false` | | +| cdn_aws_access_key_id | CDN aws access key id | `false` | | +| cdn_aws_secret_access_key | CDN aws secret access key | `false` | | +| cdn_aws_region | CDN aws region | `false` | | + + + +## Runs + +This action is a `composite` action. diff --git a/generate.sh b/generate.sh index cc2b3b71..bb5a594f 100755 --- a/generate.sh +++ b/generate.sh @@ -1,5 +1,6 @@ +pwd=`pwd` for i in `find . -name action.yaml | sed 's|/[^/]*$||'`; do - cat <$i/README.md + cat <$pwd/$i/README.md @@ -8,4 +9,6 @@ for i in `find . -name action.yaml | sed 's|/[^/]*$||'`; do EOF +cd $pwd/$i +action-docs --action ./action.yaml --update-readme done diff --git a/packages/buildx/README.md b/packages/buildx/README.md index d805e25a..e9df6c74 100644 --- a/packages/buildx/README.md +++ b/packages/buildx/README.md @@ -1,7 +1,25 @@ +## Description +Setup Docker buildx credentials & cache + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| project_id | GCP project id | `true` | | +| gcr_host | GCP container registry host | `true` | | +| cache | Run action cache | `false` | true | + + + +## Runs + +This action is a `composite` action. diff --git a/packages/cdn/README.md b/packages/cdn/README.md index d805e25a..4f0a9b15 100644 --- a/packages/cdn/README.md +++ b/packages/cdn/README.md @@ -1,7 +1,30 @@ +## Description +Manage CDN static for upload or delete + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| working_directory | Set working directory | `false` | . | +| cdn_aws_s3_bucket | CDN aws s3 bucket | `true` | | +| cdn_aws_access_key_id | CDN aws access key id | `true` | | +| cdn_aws_secret_access_key | CDN aws secret access key | `true` | | +| cdn_aws_region | CDN aws region | `true` | | +| cdn_source_dir | CDN source dir | `false` | | +| upload | Upload dir | `false` | | +| delete | Delete dir | `false` | | + + + +## Runs + +This action is a `composite` action. diff --git a/packages/gcloud/README.md b/packages/gcloud/README.md index d805e25a..54e7b96c 100644 --- a/packages/gcloud/README.md +++ b/packages/gcloud/README.md @@ -1,7 +1,24 @@ +## Description +Frontend composite deployment + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| project_id | GCP project id | `true` | | +| credentials_json | GCP credentials services account | `true` | | + + + +## Runs + +This action is a `composite` action. diff --git a/packages/gke-credential/README.md b/packages/gke-credential/README.md index d805e25a..1ee24cbf 100644 --- a/packages/gke-credential/README.md +++ b/packages/gke-credential/README.md @@ -1,7 +1,25 @@ +## Description +Get GKE Credential + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| project_id | GCP project id | `true` | | +| gke_cluster_name | GKE cluster name | `true` | | +| gke_cluster_zone | GKE cluster location zone | `true` | | + + + +## Runs + +This action is a `composite` action. diff --git a/packages/makefile/README.md b/packages/makefile/README.md index d805e25a..b8ddc87d 100644 --- a/packages/makefile/README.md +++ b/packages/makefile/README.md @@ -1,7 +1,48 @@ +## Description +Makefile build push deploy + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| project_id | GCP project id | `false` | | +| gcr_host | GCP container registry host | `false` | | +| chartmuseum_host | ChartMuseum host | `false` | | +| chartmuseum_user | ChartMuseum user | `false` | | +| chartmuseum_pass | ChartMuseum password | `false` | | +| install | make install | `false` | false | +| config | make config | `false` | false | +| build | make build | `false` | false | +| package | make package | `false` | false | +| deploy | make deploy | `false` | false | +| rollback | make rollback | `false` | false | +| rollback_release | rollback release | `false` | | +| rollback_revision | rollback revision | `false` | | +| prune | make prune | `false` | false | +| prune_all | make prune-all | `false` | false | +| destroy | make destroy | `false` | false | +| working_directory | Set working directory | `false` | . | +| using_cdn | Setup cdn for static assets | `false` | false | +| cdn_keep_latest_version | CDN keep latest version length | `false` | 2 | +| setup_helmfiles | Setup helmfiles | `false` | true | +## Outputs + +| parameter | description | +| --- | --- | +| build-time | Define build time | +| cdn-upload-path | Define cdn upload path | +| cdn-delete-path | Define cdn delete path | + + + +## Runs +This action is a `composite` action. diff --git a/packages/pnpm/README.md b/packages/pnpm/README.md index d805e25a..9601fbcf 100644 --- a/packages/pnpm/README.md +++ b/packages/pnpm/README.md @@ -1,7 +1,26 @@ +## Description +Setup pnpm & cache modules + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| working_directory | Set working directory | `false` | . | +| using_nextjs | Setup next.js cache modules | `false` | false | +| pnpm_version | Setup pnpm version | `false` | latest | +| cache | Run action cache | `false` | true | + + + +## Runs + +This action is a `composite` action. diff --git a/packages/rancher/README.md b/packages/rancher/README.md index d805e25a..dd5ee988 100644 --- a/packages/rancher/README.md +++ b/packages/rancher/README.md @@ -1,7 +1,27 @@ +## Description +configure namespace location on rancher project + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| rancher_host | Rancher host | `true` | | +| rancher_access_key | Rancher access key | `true` | | +| rancher_secret_key | Rancher secret key | `true` | | +| rancher_cluster_id | Rancher cluster id | `true` | | +| working_directory | Set working directory | `false` | . | + + + +## Runs + +This action is a `composite` action. diff --git a/packages/swagger/README.md b/packages/swagger/README.md index d805e25a..4b001517 100644 --- a/packages/swagger/README.md +++ b/packages/swagger/README.md @@ -1,7 +1,27 @@ +## Description +Setup Swagger build + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| swagger_script_path | shell script path and name for swagger env | `false` | | +| project_id | GCP project id | `false` | | +| gcr_host | GCP container registry host | `false` | | +| openapi_input_file | openapi input file | `false` | | +| openapi_output_file | openapi output file | `false` | | + + + +## Runs + +This action is a `composite` action. diff --git a/packages/yarn/README.md b/packages/yarn/README.md index d805e25a..cad2b840 100644 --- a/packages/yarn/README.md +++ b/packages/yarn/README.md @@ -1,7 +1,25 @@ +## Description +Setup yarn & cache modules + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| working_directory | Set working directory | `false` | . | +| using_nextjs | Setup next.js cache modules | `false` | false | +| cache | Run action cache | `false` | true | + + + +## Runs + +This action is a `composite` action. diff --git a/rollback/README.md b/rollback/README.md index d805e25a..08a2edb0 100644 --- a/rollback/README.md +++ b/rollback/README.md @@ -1,7 +1,28 @@ +## Description +Rollback release deployment + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| credentials_json | GCP credentials services account | `true` | | +| gke_cluster_name | GKE cluster name | `true` | | +| gke_cluster_zone | GKE cluster location zone | `true` | | +| project_id | GCP project id | `true` | | +| rollback_release | rollback release | `false` | | +| rollback_revision | rollback revision | `false` | | + + + +## Runs + +This action is a `composite` action. diff --git a/tools/frontend/lighthouse/README.md b/tools/frontend/lighthouse/README.md index d805e25a..a5ae9fa9 100644 --- a/tools/frontend/lighthouse/README.md +++ b/tools/frontend/lighthouse/README.md @@ -1,7 +1,27 @@ +## Description +Frontend tools for audit lighthouse + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| working_directory | Set working directory | `false` | . | +| urls | Set lighthouse urls | `true` | | +| budget_path | Set lighthouse budget path | `true` | | +| config_path | Set lighthouse config path | `true` | | +| gh_token | Set github token | `true` | | + + + +## Runs + +This action is a `composite` action. diff --git a/tools/frontend/nextjs-bundle-analysis/README.md b/tools/frontend/nextjs-bundle-analysis/README.md index d805e25a..53e16160 100644 --- a/tools/frontend/nextjs-bundle-analysis/README.md +++ b/tools/frontend/nextjs-bundle-analysis/README.md @@ -1,7 +1,27 @@ +## Description +Frontend tools for audit nextjs bundle analysis + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| working_directory | Set working directory | `false` | . | +| comment_header | Set comment header | `false` | Next.js Bundle Analysis | +| workflow_name | Set workflow name | `true` | | +| base_branch | Set base branch | `true` | | +| pr_number | Set pr number | `false` | | + + + +## Runs + +This action is a `composite` action. diff --git a/unit_test/backend/README.md b/unit_test/backend/README.md index d805e25a..71027a5c 100644 --- a/unit_test/backend/README.md +++ b/unit_test/backend/README.md @@ -1,7 +1,31 @@ +## Description +Build and push docker image + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| gh_user | gh user | `true` | | +| gh_token | gh token | `true` | | +| cache | enable cache for go modules | `false` | true | +| cache_dependency_path | go sum location | `false` | go.sum | +| go_version | go version | `false` | ^1.13.1 | +| need_mockery | need mockery | `false` | false | +| custom_command_flag | custom command flag | `false` | false | +| custom_command | custom command | `false` | echo no command | +| unit_test_command | unit test command | `false` | go test ./internal/... -coverpkg=./... -coverprofile=coverage.out -covermode=atomic | + + + +## Runs + +This action is a `composite` action. From 181c68be134593d0ced98fc98d8095e605bad12c Mon Sep 17 00:00:00 2001 From: dimzrio Date: Thu, 18 May 2023 16:55:03 +0700 Subject: [PATCH 04/10] Update readme --- README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) diff --git a/README.md b/README.md index 6699b198..dcded577 100644 --- a/README.md +++ b/README.md @@ -1 +1,62 @@ # Github Action Composite +This is repository of Composite GitHub Actions. + +# Basic Usage +You can choose 2 option strategy. + +Option 1: Single Job +See Example on Backend [Workflows](https://github.com/kitabisa/sangu/blob/0ceb5ee26f0550ab57201215a41eb79970b45b2f/.github/workflows/build-push-deploy-prod.yaml#L1-L42) +``` +jobs: + build-push-deploy: + runs-on: ktbs-infra-k8s-runner + + steps: + - name: Build + uses: kitabisa/composite-actions/build/backend@v1 + with: + gh_user: ${{ secrets.GH_USER }} + gh_token: ${{ secrets.GH_TOKEN }} + ..................... + + + - name: Deploy + uses: kitabisa/composite-actions/deploy/backend@v1 + with: + env: ${{ env.ENV }} + gh_token: ${{ secrets.GH_TOKEN }} + project_id: ${{ secrets.GCP_PROJECT_ID_PROD }} + ..................... + +``` + + +Option 2: Multiple Job +See Example on Frontend [Workflows](https://github.com/kitabisa/kanvas/blob/283050e921b632c9bc9dbcaab9e194f23cd9095a/.github/workflows/build-push-deploy-prod.yaml#L1-L56) +``` +jobs: + build-push: + runs-on: ktbs-infra-k8s-runner + steps: + - name: Run build & push + uses: kitabisa/composite-actions/build/frontend@main + with: + project_id: ${{ secrets.GCP_PROJECT_ID_PROD }} + credentials_json: ${{ secrets.GCP_SA_KEY_PROD }} + gcr_host: ${{ secrets.GCR_HOST }} + ..................... + + + deploy: + runs-on: ktbs-infra-k8s-runner + needs: build-push + steps: + - name: Run deploy & prune + uses: kitabisa/composite-actions/deploy/frontend@main + with: + project_id: ${{ secrets.GCP_PROJECT_ID_PROD }} + credentials_json: ${{ secrets.GCP_SA_KEY_PROD }} + gcr_host: ${{ secrets.GCR_HOST }} + ..................... + +``` From 0d8609ca3b63b714af7856c4c36dc0d43e2dae81 Mon Sep 17 00:00:00 2001 From: dimzrio Date: Thu, 18 May 2023 16:56:00 +0700 Subject: [PATCH 05/10] Update readme --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index dcded577..31a6d389 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,6 @@ This is repository of Composite GitHub Actions. You can choose 2 option strategy. Option 1: Single Job -See Example on Backend [Workflows](https://github.com/kitabisa/sangu/blob/0ceb5ee26f0550ab57201215a41eb79970b45b2f/.github/workflows/build-push-deploy-prod.yaml#L1-L42) ``` jobs: build-push-deploy: @@ -32,7 +31,6 @@ jobs: Option 2: Multiple Job -See Example on Frontend [Workflows](https://github.com/kitabisa/kanvas/blob/283050e921b632c9bc9dbcaab9e194f23cd9095a/.github/workflows/build-push-deploy-prod.yaml#L1-L56) ``` jobs: build-push: From 390a0bc997d82f3a0ba80f9cf60608e19068c1f8 Mon Sep 17 00:00:00 2001 From: dimzrio Date: Thu, 18 May 2023 16:57:01 +0700 Subject: [PATCH 06/10] Update readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 31a6d389..0f76d7b4 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ jobs: runs-on: ktbs-infra-k8s-runner steps: - name: Run build & push - uses: kitabisa/composite-actions/build/frontend@main + uses: kitabisa/composite-actions/build/frontend@v1 with: project_id: ${{ secrets.GCP_PROJECT_ID_PROD }} credentials_json: ${{ secrets.GCP_SA_KEY_PROD }} @@ -50,7 +50,7 @@ jobs: needs: build-push steps: - name: Run deploy & prune - uses: kitabisa/composite-actions/deploy/frontend@main + uses: kitabisa/composite-actions/deploy/frontend@v1 with: project_id: ${{ secrets.GCP_PROJECT_ID_PROD }} credentials_json: ${{ secrets.GCP_SA_KEY_PROD }} From 02a5ce249329c64e2688ef786ee0bd3b9a66ad8c Mon Sep 17 00:00:00 2001 From: dimzrio Date: Fri, 19 May 2023 10:04:12 +0700 Subject: [PATCH 07/10] Update doc --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0f76d7b4..4b331369 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Github Action Composite This is repository of Composite GitHub Actions. +- build +- Deploy + # Basic Usage You can choose 2 option strategy. @@ -34,7 +37,7 @@ Option 2: Multiple Job ``` jobs: build-push: - runs-on: ktbs-infra-k8s-runner + runs-on: k8s-runner steps: - name: Run build & push uses: kitabisa/composite-actions/build/frontend@v1 @@ -46,7 +49,7 @@ jobs: deploy: - runs-on: ktbs-infra-k8s-runner + runs-on: k8s-runner needs: build-push steps: - name: Run deploy & prune From c3175e6ee292cf45f9f6d33e997d788b543030f8 Mon Sep 17 00:00:00 2001 From: dimzrio Date: Fri, 19 May 2023 10:05:49 +0700 Subject: [PATCH 08/10] Update doc --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4b331369..5e7983b5 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Github Action Composite This is repository of Composite GitHub Actions. - build -- Deploy - +- deploy +- rollback # Basic Usage You can choose 2 option strategy. @@ -11,7 +11,7 @@ Option 1: Single Job ``` jobs: build-push-deploy: - runs-on: ktbs-infra-k8s-runner + runs-on: k8s-runner steps: - name: Build From 475ea2576b8c994198569ac6843ad555b1a9f986 Mon Sep 17 00:00:00 2001 From: dimzrio Date: Fri, 19 May 2023 10:10:20 +0700 Subject: [PATCH 09/10] Update doc --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e7983b5..9ceae2f2 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # Github Action Composite -This is repository of Composite GitHub Actions. +This is main of Composite GitHub Actions. - build - deploy - rollback +- destroy (dev release) # Basic Usage You can choose 2 option strategy. From 7437797b2d6ac29782a593e74a9c8b6c1d831a64 Mon Sep 17 00:00:00 2001 From: dimzrio Date: Fri, 19 May 2023 10:14:46 +0700 Subject: [PATCH 10/10] Update doc --- generate.sh | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100755 generate.sh diff --git a/generate.sh b/generate.sh deleted file mode 100755 index bb5a594f..00000000 --- a/generate.sh +++ /dev/null @@ -1,14 +0,0 @@ -pwd=`pwd` -for i in `find . -name action.yaml | sed 's|/[^/]*$||'`; do - cat <$pwd/$i/README.md - - - - - - - -EOF -cd $pwd/$i -action-docs --action ./action.yaml --update-readme -done