Switching back to artIfacts.

Author: borisbaldassari

.github/workflows/release.yml

@@ -6,8 +6,8 @@ concurrency:
   group: "release-${{ github.head_ref || github.ref }}"
   cancel-in-progress: true
 jobs:
-  quality_artefacts_job:
-    name: A job to collect quality artefacts
+  quality_artifacts_job:
+    name: A job to collect quality artifacts
     runs-on: ubuntu-latest
     permissions: write-all
     steps:
@@ -20,17 +20,17 @@ jobs:
         run: |
           echo ${{ steps.create_release.outputs.url }}
       # Call the quevee gh action to create the manifest file for SDV maturity assessment.
-      - name: Collect quality artefacts
+      - name: Collect quality artifacts
         uses: eclipse-dash/quevee
         id: quevee
         with:
           release_url: ${{ steps.create_release.outputs.url }}
-          artefacts_readme: README.md
-          artefacts_requirements: docs/requirements.md
-          artefacts_testing: tests/test_report.md
-          artefacts_documentation: docs/getting_started/README.md
-          artefacts_coding_guidelines: docs/coding_guidelines.md
-          artefacts_release_process: https://example.org/docs/my_release_process.md
+          artifacts_readme: README.md
+          artifacts_requirements: docs/requirements.md
+          artifacts_testing: tests/test_report.md
+          artifacts_documentation: docs/getting_started/README.md
+          artifacts_coding_guidelines: docs/coding_guidelines.md
+          artifacts_release_process: https://example.org/docs/my_release_process.md
       - name: Upload quality manifest to release
         uses: svenstaro/upload-release-action@v2
         with:

README.md

@@ -10,16 +10,16 @@ To use this action, one simply needs to add the following steps in their release
 
 ```yaml
       # Call the quevee gh action to create the manifest file for SDV maturity assessment.
-      - name: Collect quality artefacts
+      - name: Collect quality artifacts
         uses: eclipse-dash/quevee
         id: quevee
         with:
           release_url: ${{ steps.create_release.outputs.url }}
-          artefacts_requirements: <path/to/requirements_file>
-          artefacts_testing: <path/to/testing_document_1>,<path/to/testing_document_2> 
-          artefacts_documentation: <path/to/documentation>
-          artefacts_coding_guidelines: <path/to/coding_guidelines>
-          artefacts_release_process: <path/to/release_process>
+          artifacts_requirements: <path/to/requirements_file>
+          artifacts_testing: <path/to/testing_document_1>,<path/to/testing_document_2> 
+          artifacts_documentation: <path/to/documentation>
+          artifacts_coding_guidelines: <path/to/coding_guidelines>
+          artifacts_release_process: <path/to/release_process>
       - name: Upload quality manifest to release
         uses: svenstaro/upload-release-action@v2
         with:
@@ -34,10 +34,10 @@ The various <path/to/file> placeholders can either be:
 * a full URL to a resource, e.g. `https://myproject/docs/getting_started.pdf`.
 
 If one needs to provide several files for a given criterion, there are two options:
-* provide a comma-separated list of files, as shown for the artefacts_testing example above, or
+* provide a comma-separated list of files, as shown for the artifacts_testing example above, or
 * provide an archive, with a separate github action step.
 
-An example of a step archiving artefacts can be:
+An example of a step archiving artifacts can be:
 ```yaml
       - name: Gather Testing documents
         shell: bash
@@ -55,7 +55,7 @@ An example of a step archiving artefacts can be:
 This in turn can be referenced in the quevee call as:
 ```yaml
           ...
-          artefacts_testing: ${{ steps.upload_spec.outputs.browser_download_url }}
+          artifacts_testing: ${{ steps.upload_spec.outputs.browser_download_url }}
           ...
 ```
 

action.yml

@@ -7,43 +7,43 @@
 # SPDX-License-Identifier: EPL-2.0
 #
 name: 'quevee'
-description: 'QUality-EVEnt Engine for collecting quality-related build and release artefacts'
+description: 'QUality-EVEnt Engine for collecting quality-related build and release artifacts'
 branding:
   icon: 'award'
   color: 'green'
 inputs:
   release_url:
     description: 'URL of the release this manifest refers to'
     required: false
-  artefacts_readme:
+  artifacts_readme:
     description: 'Comma-separated list of URLs of READMEs'
     required: false
-  artefacts_requirements:
+  artifacts_requirements:
     description: 'Comma-separated list of URLs of requirement files'
     required: false
-  artefacts_testing:
+  artifacts_testing:
     description: 'Comma-separated list of URLs of test results'
     required: false
-  artefacts_documentation:
-    description: 'Comma-separated list of URLs of documentation artefacts'
+  artifacts_documentation:
+    description: 'Comma-separated list of URLs of documentation artifacts'
     required: false
-  artefacts_coding_guidelines:
+  artifacts_coding_guidelines:
     description: 'Comma-separated list of URLs of coding guidelines documents'
     required: false
-  artefacts_release_process:
+  artifacts_release_process:
     description: 'Comma-separated list of URLs of release process information'
     required: false
 outputs:
   manifest_file:
-    description: 'Process artefacts manifest file name'
+    description: 'Process artifacts manifest file name'
 runs:
   using: 'docker'
   image: 'Dockerfile'
   args:
     - ${{ inputs.release_url }}
-    - ${{ inputs.artefacts_readme }}
-    - ${{ inputs.artefacts_requirements }}
-    - ${{ inputs.artefacts_testing }}
-    - ${{ inputs.artefacts_documentation }}
-    - ${{ inputs.artefacts_coding_guidelines }}
-    - ${{ inputs.artefacts_release_process }}
+    - ${{ inputs.artifacts_readme }}
+    - ${{ inputs.artifacts_requirements }}
+    - ${{ inputs.artifacts_testing }}
+    - ${{ inputs.artifacts_documentation }}
+    - ${{ inputs.artifacts_coding_guidelines }}
+    - ${{ inputs.artifacts_release_process }}

sdv-manifest.sh

@@ -90,26 +90,26 @@ for var in $(env | grep "^INPUT_" | cut -d= -f1); do
     value="${!var}"
 
     case "$var" in
-    "INPUT_ARTEFACTS_README")
+    "INPUT_ARTIFACTS_README")
         generate_toml_section "readme" "$value" >>"$OUTPUT"
         ;;
-    "INPUT_ARTEFACTS_REQUIREMENTS")
+    "INPUT_ARTIFACTS_REQUIREMENTS")
         generate_toml_section "requirements" "$value" >>"$OUTPUT"
         ;;
-    "INPUT_ARTEFACTS_TESTING")
+    "INPUT_ARTIFACTS_TESTING")
         generate_toml_section "testing" "$value" >>"$OUTPUT"
         ;;
-    "INPUT_ARTEFACTS_DOCUMENTATION")
+    "INPUT_ARTIFACTS_DOCUMENTATION")
         generate_toml_section "documentation" "$value" >>"$OUTPUT"
         ;;
-    "INPUT_ARTEFACTS_CODING_GUIDELINES")
+    "INPUT_ARTIFACTS_CODING_GUIDELINES")
         generate_toml_section "coding_guidelines" "$value" >>"$OUTPUT"
         ;;
-    "INPUT_ARTEFACTS_RELEASE_PROCESS")
+    "INPUT_ARTIFACTS_RELEASE_PROCESS")
         generate_toml_section "release_process" "$value" >>"$OUTPUT"
         ;;
     *)
-        echo "Unknown artefact type ${var#INPUT_ARTEFACTS_}"
+        echo "Unknown artifact type ${var#INPUT_ARTIFACTS_}"
         ;;
     esac
 done

tools/test_runner.sh

@@ -15,11 +15,11 @@ export GITHUB_REPOSITORY=eclipse-dash/quevee
 export GITHUB_REF_NAME=main
 export GITHUB_WORKFLOW_SHA=e69b6ff8f67e0d2edfd0968ebc5f99d7e8d763c7
 
-export INPUT_ARTEFACTS_README="https://some.example.url,https://other.example.url"
-export INPUT_ARTEFACTS_REQUIREMENTS="another/file.md,https://another.org/example-test/artefact.bz2"
-export INPUT_ARTEFACTS_TESTING="http://first.doc.com/doc/url,https://another.doc.com/example/docs.zip"
-export INPUT_ARTEFACTS_DOCUMENTATION="./Random/URL,https://another.org/example/artefact.bz2"
-export INPUT_ARTEFACTS_CODING_GUIDELINES="./SomeOther/URL,https://another.org/example/artefact.bz2"
-export INPUT_ARTEFACTS_RELEASE_PROCESS="./YetAnother/URL,https://another.org/example/artefact.bz2"
+export INPUT_ARTIFACTS_README="https://some.example.url,https://other.example.url"
+export INPUT_ARTIFACTS_REQUIREMENTS="another/file.md,https://another.org/example-test/artifact.bz2"
+export INPUT_ARTIFACTS_TESTING="http://first.doc.com/doc/url,https://another.doc.com/example/docs.zip"
+export INPUT_ARTIFACTS_DOCUMENTATION="./Random/URL,https://another.org/example/artifact.bz2"
+export INPUT_ARTIFACTS_CODING_GUIDELINES="./SomeOther/URL,https://another.org/example/artifact.bz2"
+export INPUT_ARTIFACTS_RELEASE_PROCESS="./YetAnother/URL,https://another.org/example/artifact.bz2"
 
 ./sdv-manifest.sh