From eb09952dead1e490a4d7b3ecbf455f5b039cee14 Mon Sep 17 00:00:00 2001 From: Juan Navarro Date: Tue, 28 Nov 2023 13:28:46 +0100 Subject: [PATCH] .github: Workflow file renames that were pending commit Some normalization of the files, to follow docs on Reusable Commits, which call them "caller" and "called" workflows. Also, closer follow of the same directory path in the workflow names. So, the workflow for "clients/java" is called exactly like that, and this applies to all workflows. Exception for javascript: "js" is used as a shorthand. Also no need to use a generic word like "build" in names. It doesn't say anything we didn't know, of course most CI jobs are for "building" things. --- .github/workflows/000-template.yaml | 2 +- .github/workflows/001-playground.yaml | 4 +-- .github/workflows/README.md | 2 +- ...reusable.yaml => clients-java.called.yaml} | 2 +- ...a-parent.yaml => clients-java.caller.yaml} | 28 +++++++++---------- ...le.yaml => clients-javascript.called.yaml} | 2 +- ...nt.yaml => clients-javascript.caller.yaml} | 18 ++++++------ .github/workflows/doc-kurento.yaml | 2 +- .../docker-kurento-buildpackage.yaml | 2 +- .../docker-kurento-ci-buildtools.yaml | 2 +- ...e.yaml => server-buildpackage.called.yaml} | 2 +- ...ble.yaml => server-deploy-aws.called.yaml} | 2 +- ....yaml => server-deploy-debian.called.yaml} | 2 +- ....yaml => server-deploy-docker.called.yaml} | 4 +-- ...{server-parent.yaml => server.caller.yaml} | 26 ++++++++--------- 15 files changed, 50 insertions(+), 50 deletions(-) rename .github/workflows/{clients-java-build.reusable.yaml => clients-java.called.yaml} (98%) rename .github/workflows/{clients-java-parent.yaml => clients-java.caller.yaml} (80%) rename .github/workflows/{clients-javascript-build.reusable.yaml => clients-javascript.called.yaml} (98%) rename .github/workflows/{clients-javascript-parent.yaml => clients-javascript.caller.yaml} (80%) rename .github/workflows/{server-buildpackage.reusable.yaml => server-buildpackage.called.yaml} (98%) rename .github/workflows/{server-deploy-aws.reusable.yaml => server-deploy-aws.called.yaml} (97%) rename .github/workflows/{server-deploy-debian.reusable.yaml => server-deploy-debian.called.yaml} (98%) rename .github/workflows/{server-deploy-docker.reusable.yaml => server-deploy-docker.called.yaml} (98%) rename .github/workflows/{server-parent.yaml => server.caller.yaml} (88%) diff --git a/.github/workflows/000-template.yaml b/.github/workflows/000-template.yaml index 1a51b1317..726030482 100644 --- a/.github/workflows/000-template.yaml +++ b/.github/workflows/000-template.yaml @@ -1,4 +1,4 @@ -name: "Workflow template" +name: "workflow template" on: # Manual trigger. diff --git a/.github/workflows/001-playground.yaml b/.github/workflows/001-playground.yaml index aab2bb5e4..471cc0634 100644 --- a/.github/workflows/001-playground.yaml +++ b/.github/workflows/001-playground.yaml @@ -1,5 +1,5 @@ -# Workflow used to play with Actions syntax. -name: "GitHub: Workflow playground" +# Workflow used to experiment with GitHub Actions syntax. +name: "workflow playground" on: # Triggered manually. diff --git a/.github/workflows/README.md b/.github/workflows/README.md index b3013fa55..a1398b846 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -12,7 +12,7 @@ Information of interest that is common for all workflows: - [Workflow syntax](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) - [Workflow commands](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions) - - [Docker actions](https://docs.docker.com/build/ci/github-actions/) + - [Reusable workflows](https://docs.github.com/en/actions/using-workflows/reusing-workflows) * Advanced: diff --git a/.github/workflows/clients-java-build.reusable.yaml b/.github/workflows/clients-java.called.yaml similarity index 98% rename from .github/workflows/clients-java-build.reusable.yaml rename to .github/workflows/clients-java.called.yaml index 9e1f185d2..a2bdb817c 100644 --- a/.github/workflows/clients-java-build.reusable.yaml +++ b/.github/workflows/clients-java.called.yaml @@ -1,4 +1,4 @@ -name: "Clients: Build Java module (Reusable workflow)" +name: "clients/java module (child)" on: # Triggered from other workflows. diff --git a/.github/workflows/clients-java-parent.yaml b/.github/workflows/clients-java.caller.yaml similarity index 80% rename from .github/workflows/clients-java-parent.yaml rename to .github/workflows/clients-java.caller.yaml index 97c37726c..356298a73 100644 --- a/.github/workflows/clients-java-parent.yaml +++ b/.github/workflows/clients-java.caller.yaml @@ -1,4 +1,4 @@ -name: "Clients: Build All Java (Parent)" +name: "clients/java all (parent)" on: # Triggered manually. @@ -12,14 +12,14 @@ on: jobs: qa-pom: - uses: "./.github/workflows/clients-java-build.reusable.yaml" + uses: "./.github/workflows/clients-java.called.yaml" with: directory: "clients/java/qa-pom/" copyArtifacts: false secrets: inherit module-creator: - uses: "./.github/workflows/clients-java-build.reusable.yaml" + uses: "./.github/workflows/clients-java.called.yaml" with: directory: "server/module-creator/" copyArtifacts: false @@ -27,14 +27,14 @@ jobs: maven-plugin: needs: ["module-creator"] - uses: "./.github/workflows/clients-java-build.reusable.yaml" + uses: "./.github/workflows/clients-java.called.yaml" with: directory: "clients/java/maven-plugin/" secrets: inherit module-core: needs: ["maven-plugin"] - uses: "./.github/workflows/clients-java-build.reusable.yaml" + uses: "./.github/workflows/clients-java.called.yaml" with: directory: "server/module-core/" genModuleEnable: true @@ -43,7 +43,7 @@ jobs: module-elements: needs: ["module-core"] - uses: "./.github/workflows/clients-java-build.reusable.yaml" + uses: "./.github/workflows/clients-java.called.yaml" with: directory: "server/module-elements/" genModuleEnable: true @@ -52,7 +52,7 @@ jobs: module-filters: needs: ["module-elements"] - uses: "./.github/workflows/clients-java-build.reusable.yaml" + uses: "./.github/workflows/clients-java.called.yaml" with: directory: "server/module-filters/" genModuleEnable: true @@ -61,14 +61,14 @@ jobs: client: needs: ["qa-pom", "module-filters"] - uses: "./.github/workflows/clients-java-build.reusable.yaml" + uses: "./.github/workflows/clients-java.called.yaml" with: directory: "clients/java/" secrets: inherit module-chroma: needs: ["client"] - uses: "./.github/workflows/clients-java-build.reusable.yaml" + uses: "./.github/workflows/clients-java.called.yaml" with: directory: "server/module-examples/chroma/" genModuleEnable: true @@ -78,7 +78,7 @@ jobs: # Unavailable since Kurento 7.0.0 #module-crowddetector: # needs: ["client"] - # uses: "./.github/workflows/clients-java-build.reusable.yaml" + # uses: "./.github/workflows/clients-java.called.yaml" # with: # directory: "server/module-examples/crowddetector/" # genModuleEnable: true @@ -87,7 +87,7 @@ jobs: module-datachannelexample: needs: ["client"] - uses: "./.github/workflows/clients-java-build.reusable.yaml" + uses: "./.github/workflows/clients-java.called.yaml" with: directory: "server/module-examples/datachannelexample/" genModuleEnable: true @@ -97,7 +97,7 @@ jobs: # Unavailable since Kurento 7.0.0 #module-markerdetector: # needs: ["client"] - # uses: "./.github/workflows/clients-java-build.reusable.yaml" + # uses: "./.github/workflows/clients-java.called.yaml" # with: # directory: "server/module-examples/markerdetector/" # genModuleEnable: true @@ -107,7 +107,7 @@ jobs: # Unavailable since Kurento 7.0.0 #module-platedetector: # needs: ["client"] - # uses: "./.github/workflows/clients-java-build.reusable.yaml" + # uses: "./.github/workflows/clients-java.called.yaml" # with: # directory: "server/module-examples/platedetector/" # genModuleEnable: true @@ -117,7 +117,7 @@ jobs: # Unavailable since Kurento 7.0.0 #module-pointerdetector: # needs: ["client"] - # uses: "./.github/workflows/clients-java-build.reusable.yaml" + # uses: "./.github/workflows/clients-java.called.yaml" # with: # directory: "server/module-examples/pointerdetector/" # genModuleEnable: true diff --git a/.github/workflows/clients-javascript-build.reusable.yaml b/.github/workflows/clients-javascript.called.yaml similarity index 98% rename from .github/workflows/clients-javascript-build.reusable.yaml rename to .github/workflows/clients-javascript.called.yaml index b9460e0e6..caceb6bb5 100644 --- a/.github/workflows/clients-javascript-build.reusable.yaml +++ b/.github/workflows/clients-javascript.called.yaml @@ -1,4 +1,4 @@ -name: "Clients: Build JavaScript module (Reusable workflow)" +name: "clients/js module (child)" on: # Triggered from other workflows. diff --git a/.github/workflows/clients-javascript-parent.yaml b/.github/workflows/clients-javascript.caller.yaml similarity index 80% rename from .github/workflows/clients-javascript-parent.yaml rename to .github/workflows/clients-javascript.caller.yaml index 87bb22eac..122ef2986 100644 --- a/.github/workflows/clients-javascript-parent.yaml +++ b/.github/workflows/clients-javascript.caller.yaml @@ -1,4 +1,4 @@ -name: "Clients: Build All JavaScript (Parent)" +name: "clients/js all (parent)" on: # Triggered manually. @@ -17,14 +17,14 @@ on: jobs: kurento-utils-js: - uses: "./.github/workflows/clients-javascript-build.reusable.yaml" + uses: "./.github/workflows/clients-javascript.called.yaml" with: jobRelease: ${{ inputs.jobRelease }} directory: "browser/kurento-utils-js/" secrets: inherit module-core: - uses: "./.github/workflows/clients-javascript-build.reusable.yaml" + uses: "./.github/workflows/clients-javascript.called.yaml" with: jobRelease: ${{ inputs.jobRelease }} directory: "server/module-core/" @@ -33,7 +33,7 @@ jobs: secrets: inherit module-elements: - uses: "./.github/workflows/clients-javascript-build.reusable.yaml" + uses: "./.github/workflows/clients-javascript.called.yaml" with: jobRelease: ${{ inputs.jobRelease }} directory: "server/module-elements/" @@ -42,7 +42,7 @@ jobs: secrets: inherit module-filters: - uses: "./.github/workflows/clients-javascript-build.reusable.yaml" + uses: "./.github/workflows/clients-javascript.called.yaml" with: jobRelease: ${{ inputs.jobRelease }} directory: "server/module-filters/" @@ -51,7 +51,7 @@ jobs: secrets: inherit jsonrpc: - uses: "./.github/workflows/clients-javascript-build.reusable.yaml" + uses: "./.github/workflows/clients-javascript.called.yaml" with: jobRelease: ${{ inputs.jobRelease }} directory: "clients/javascript/jsonrpc/" @@ -59,14 +59,14 @@ jobs: client: needs: ["module-core", "module-elements", "module-filters", "jsonrpc"] - uses: "./.github/workflows/clients-javascript-build.reusable.yaml" + uses: "./.github/workflows/clients-javascript.called.yaml" with: jobRelease: ${{ inputs.jobRelease }} directory: "clients/javascript/client/" secrets: inherit module-chroma: - uses: "./.github/workflows/clients-javascript-build.reusable.yaml" + uses: "./.github/workflows/clients-javascript.called.yaml" with: jobRelease: ${{ inputs.jobRelease }} directory: "server/module-examples/chroma/" @@ -77,7 +77,7 @@ jobs: #module-crowddetector: module-datachannelexample: - uses: "./.github/workflows/clients-javascript-build.reusable.yaml" + uses: "./.github/workflows/clients-javascript.called.yaml" with: jobRelease: ${{ inputs.jobRelease }} directory: "server/module-examples/datachannelexample/" diff --git a/.github/workflows/doc-kurento.yaml b/.github/workflows/doc-kurento.yaml index e3296c7f5..66d7dc459 100644 --- a/.github/workflows/doc-kurento.yaml +++ b/.github/workflows/doc-kurento.yaml @@ -1,4 +1,4 @@ -name: "Documentation build" +name: "doc-kurento" on: # Manual trigger. diff --git a/.github/workflows/docker-kurento-buildpackage.yaml b/.github/workflows/docker-kurento-buildpackage.yaml index c3d7d8e7a..565506e4c 100644 --- a/.github/workflows/docker-kurento-buildpackage.yaml +++ b/.github/workflows/docker-kurento-buildpackage.yaml @@ -1,4 +1,4 @@ -name: "Docker: Build kurento-buildpackage" +name: "docker/kurento-buildpackage" on: # Manual trigger. diff --git a/.github/workflows/docker-kurento-ci-buildtools.yaml b/.github/workflows/docker-kurento-ci-buildtools.yaml index 5ecb89bfa..d667bac0e 100644 --- a/.github/workflows/docker-kurento-ci-buildtools.yaml +++ b/.github/workflows/docker-kurento-ci-buildtools.yaml @@ -1,4 +1,4 @@ -name: "Docker: Build kurento-ci-buildtools" +name: "docker/kurento-ci-buildtools" on: # Manual trigger. diff --git a/.github/workflows/server-buildpackage.reusable.yaml b/.github/workflows/server-buildpackage.called.yaml similarity index 98% rename from .github/workflows/server-buildpackage.reusable.yaml rename to .github/workflows/server-buildpackage.called.yaml index faf04749b..f8a529f0e 100644 --- a/.github/workflows/server-buildpackage.reusable.yaml +++ b/.github/workflows/server-buildpackage.called.yaml @@ -1,4 +1,4 @@ -name: "Server: Build module (Reusable workflow)" +name: "server module (child)" on: # Triggered from other workflows. diff --git a/.github/workflows/server-deploy-aws.reusable.yaml b/.github/workflows/server-deploy-aws.called.yaml similarity index 97% rename from .github/workflows/server-deploy-aws.reusable.yaml rename to .github/workflows/server-deploy-aws.called.yaml index d7f22baae..07d462a44 100644 --- a/.github/workflows/server-deploy-aws.reusable.yaml +++ b/.github/workflows/server-deploy-aws.called.yaml @@ -1,4 +1,4 @@ -name: "Server: Deploy AWS CloudFormation" +name: "server deploy aws (child)" on: # Triggered from other workflows. diff --git a/.github/workflows/server-deploy-debian.reusable.yaml b/.github/workflows/server-deploy-debian.called.yaml similarity index 98% rename from .github/workflows/server-deploy-debian.reusable.yaml rename to .github/workflows/server-deploy-debian.called.yaml index cbc2597a4..bcb9f5de4 100644 --- a/.github/workflows/server-deploy-debian.reusable.yaml +++ b/.github/workflows/server-deploy-debian.called.yaml @@ -1,4 +1,4 @@ -name: "Server: Deploy DEB" +name: "server deploy debian (child)" on: # Triggered from other workflows. diff --git a/.github/workflows/server-deploy-docker.reusable.yaml b/.github/workflows/server-deploy-docker.called.yaml similarity index 98% rename from .github/workflows/server-deploy-docker.reusable.yaml rename to .github/workflows/server-deploy-docker.called.yaml index c93621ee8..425b87018 100644 --- a/.github/workflows/server-deploy-docker.reusable.yaml +++ b/.github/workflows/server-deploy-docker.called.yaml @@ -1,4 +1,4 @@ -name: "Server: Deploy Docker" +name: "server deploy docker (child)" on: # Triggered from other workflows. @@ -12,7 +12,7 @@ on: type: "string" default: '["focal"]' jobRelease: - description: "jobRelease: Enable to build release versions Disable for development builds" + description: "jobRelease: Enable to build release versions; disable for development builds" required: false type: "boolean" default: false diff --git a/.github/workflows/server-parent.yaml b/.github/workflows/server.caller.yaml similarity index 88% rename from .github/workflows/server-parent.yaml rename to .github/workflows/server.caller.yaml index 59fc52a5a..d9fe4b557 100644 --- a/.github/workflows/server-parent.yaml +++ b/.github/workflows/server.caller.yaml @@ -1,4 +1,4 @@ -name: "Server: Build All (Parent)" +name: "server all (parent)" on: # Triggered manually. @@ -80,7 +80,7 @@ jobs: jobRelease: ${{ inputs.jobRelease }} module-creator: - uses: "./.github/workflows/server-buildpackage.reusable.yaml" + uses: "./.github/workflows/server-buildpackage.called.yaml" with: jobDistros: "${{ inputs.jobDistros }}" jobGitName: "${{ inputs.jobGitName }}" @@ -90,7 +90,7 @@ jobs: copyArtifacts: false cmake-utils: - uses: "./.github/workflows/server-buildpackage.reusable.yaml" + uses: "./.github/workflows/server-buildpackage.called.yaml" with: jobDistros: "${{ inputs.jobDistros }}" jobGitName: "${{ inputs.jobGitName }}" @@ -101,7 +101,7 @@ jobs: jsonrpc: needs: ["cmake-utils"] - uses: "./.github/workflows/server-buildpackage.reusable.yaml" + uses: "./.github/workflows/server-buildpackage.called.yaml" with: jobDistros: "${{ inputs.jobDistros }}" jobGitName: "${{ inputs.jobGitName }}" @@ -111,7 +111,7 @@ jobs: module-core: needs: ["module-creator", "cmake-utils", "jsonrpc"] - uses: "./.github/workflows/server-buildpackage.reusable.yaml" + uses: "./.github/workflows/server-buildpackage.called.yaml" with: jobDistros: "${{ inputs.jobDistros }}" jobGitName: "${{ inputs.jobGitName }}" @@ -121,7 +121,7 @@ jobs: module-elements: needs: ["openh264-gst-plugin", "libnice", "module-core"] - uses: "./.github/workflows/server-buildpackage.reusable.yaml" + uses: "./.github/workflows/server-buildpackage.called.yaml" with: jobDistros: "${{ inputs.jobDistros }}" jobGitName: "${{ inputs.jobGitName }}" @@ -131,7 +131,7 @@ jobs: module-filters: needs: ["module-elements"] - uses: "./.github/workflows/server-buildpackage.reusable.yaml" + uses: "./.github/workflows/server-buildpackage.called.yaml" with: jobDistros: "${{ inputs.jobDistros }}" jobGitName: "${{ inputs.jobGitName }}" @@ -141,7 +141,7 @@ jobs: media-server: needs: ["libsrtp", "gst-plugins-good", "module-filters"] - uses: "./.github/workflows/server-buildpackage.reusable.yaml" + uses: "./.github/workflows/server-buildpackage.called.yaml" with: jobDistros: "${{ inputs.jobDistros }}" jobGitName: "${{ inputs.jobGitName }}" @@ -151,7 +151,7 @@ jobs: module-chroma: needs: ["module-filters"] - uses: "./.github/workflows/server-buildpackage.reusable.yaml" + uses: "./.github/workflows/server-buildpackage.called.yaml" with: jobDistros: "${{ inputs.jobDistros }}" jobGitName: "${{ inputs.jobGitName }}" @@ -161,7 +161,7 @@ jobs: module-datachannelexample: needs: ["module-filters"] - uses: "./.github/workflows/server-buildpackage.reusable.yaml" + uses: "./.github/workflows/server-buildpackage.called.yaml" with: jobDistros: "${{ inputs.jobDistros }}" jobGitName: "${{ inputs.jobGitName }}" @@ -171,7 +171,7 @@ jobs: deploy-deb: needs: ["media-server", "module-chroma", "module-datachannelexample"] - uses: "./.github/workflows/server-deploy-debian.reusable.yaml" + uses: "./.github/workflows/server-deploy-debian.called.yaml" with: jobDistros: "${{ inputs.jobDistros }}" jobRelease: ${{ inputs.jobRelease }} @@ -181,7 +181,7 @@ jobs: deploy-docker: needs: ["deploy-deb"] - uses: "./.github/workflows/server-deploy-docker.reusable.yaml" + uses: "./.github/workflows/server-deploy-docker.called.yaml" with: jobDistros: "${{ inputs.jobDistros }}" jobRelease: ${{ inputs.jobRelease }} @@ -194,6 +194,6 @@ jobs: # TODO: Move script to use Kurento ci-scripts/ and not openvidu ci-scripts/ # deploy-aws: # needs: ["media-server"] - # uses: "./.github/workflows/server-deploy-aws.reusable.yaml" + # uses: "./.github/workflows/server-deploy-aws.called.yaml" # with: # jobRelease: ${{ inputs.jobRelease }}