diff --git a/.github/actions/action-build-image/action.yml b/.github/actions/action-build-image/action.yml index 3338225..c51cf18 100644 --- a/.github/actions/action-build-image/action.yml +++ b/.github/actions/action-build-image/action.yml @@ -1,4 +1,4 @@ -name: "Build Docker Image" +name: action-build-image description: "Builds and pushes a docker image" inputs: diff --git a/.github/actions/action-codeql/action.yml b/.github/actions/action-codeql/action.yml index 6f454b8..df82985 100644 --- a/.github/actions/action-codeql/action.yml +++ b/.github/actions/action-codeql/action.yml @@ -1,4 +1,4 @@ -name: "Advanced CodeQL action" +name: "action-codeql" description: "Scans a repository using provided CodeQL language, buildmode and query scan set" inputs: diff --git a/.github/actions/action-maven-build/action.yml b/.github/actions/action-maven-build/action.yml index 3202d10..b38f29f 100644 --- a/.github/actions/action-maven-build/action.yml +++ b/.github/actions/action-maven-build/action.yml @@ -1,13 +1,15 @@ -name: Compliance check and build test +name: action-maven-build inputs: java-version: required: false default: 21 type: string + description: set the java version app-path: required: true type: string + description: path to the pom.xml outputs: artifact-name: description: "name of the artifact upload" diff --git a/.github/actions/action-maven-release/action.yml b/.github/actions/action-maven-release/action.yml index 5eef728..2bb53ae 100644 --- a/.github/actions/action-maven-release/action.yml +++ b/.github/actions/action-maven-release/action.yml @@ -1,37 +1,47 @@ -name: Maven Release +name: "action-maven-release" inputs: java-version: required: false default: 21 type: string + description: configure the java version app-path: required: true type: string + description: path where the pom.xml is releaseVersion: required: true type: string + description: version which will be released developmentVersion: required: true type: string + description: next version with snapshot skipDeployment: default: true type: boolean + description: skip deployment to maven central SIGN_KEY_PASS: required: true type: string + description: env variable for GPG private key passphrase CENTRAL_USERNAME: required: true type: string + description: env variable for username in deploy CENTRAL_PASSWORD: required: true type: string + description: env variable for token in deploy GDP_PRIVATE_KEY: required: true type: string + description: Value of the GPG private key to import outputs: MVN_ARTIFACT_ID: + description: "artifact name from pom" value: ${{ steps.maven-release-step.outputs.MVN_ARTIFACT_ID }} artifact-name: description: "name of the artifact upload" diff --git a/.github/actions/action-npm-build/action.yml b/.github/actions/action-npm-build/action.yml index 709f41f..28452d3 100644 --- a/.github/actions/action-npm-build/action.yml +++ b/.github/actions/action-npm-build/action.yml @@ -1,13 +1,14 @@ -name: Compliance check and build test - +name: "action-npm-build" inputs: node-version: required: false default: "22.11.0" type: string + description: node version app-path: required: true type: string + description: path where the package.json is located outputs: artifact-name: description: "name of the artifact upload" diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index 493438d..0eb686e 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -1,5 +1,5 @@ # https://vitepress.dev/guide/deploy#github-pages -name: Deploy Pages +name: deploy-pages on: workflow_call: inputs: @@ -7,18 +7,22 @@ on: required: false default: "./docs" type: string + description: location where the vitepress project is located node-version: required: false default: "22" type: string + description: node version build-cmd: required: false default: "build" type: string + description: change the build command, for use of vuepress dist-path: required: false default: ".vitepress/dist" type: string + description: output path of vite, which should be uploaded to github pages # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages permissions: diff --git a/workflow-templates/deploy-docs.properties.json b/workflow-templates/deploy-docs.properties.json index 133c3e1..f05b6e5 100644 --- a/workflow-templates/deploy-docs.properties.json +++ b/workflow-templates/deploy-docs.properties.json @@ -1,4 +1,4 @@ { - "name": "Deploy docs github pages", + "name": "deploy-docs", "description": "Deploys the docs folder in github pages" } diff --git a/workflow-templates/maven-node-build.properties.json b/workflow-templates/maven-node-build.properties.json index b92b70f..db407f1 100644 --- a/workflow-templates/maven-node-build.properties.json +++ b/workflow-templates/maven-node-build.properties.json @@ -1,4 +1,4 @@ { "name": "Maven-Node-Build", - "description": "Bauen eines Refarch Apigateway oder Backend" + "description": "Build a Refarch Apigateway or Backend" } diff --git a/workflow-templates/maven-node-build.yaml b/workflow-templates/maven-node-build.yaml index 8290d51..c6ece93 100644 --- a/workflow-templates/maven-node-build.yaml +++ b/workflow-templates/maven-node-build.yaml @@ -9,9 +9,9 @@ jobs: strategy: fail-fast: false matrix: - include: # hier müssen die Pfade angegeben werden - - app-path: # z. B. refarch-eai - - app-path: # z. B. refarch-webcomponent + include: # here you may change the path + - app-path: # eg. refarch-eai + - app-path: # eg. refarch-webcomponent steps: - uses: actions/checkout@v4 - if: ${{hashFiles(format('./{0}/package.json', matrix.app-path))!=null}}