From b7f9ab1f240176d4c114f14af8c48e8d7abb735b Mon Sep 17 00:00:00 2001 From: NejcKle Date: Tue, 19 Dec 2023 13:52:59 +0100 Subject: [PATCH] Remove unused comments, update README --- .github/workflows/build.yaml | 3 --- .github/workflows/codechecker.yaml | 2 -- .github/workflows/twister.yaml | 26 ++++++++++++-------------- README.md | 2 +- scripts/rpi-jlink-server/README.md | 2 +- 5 files changed, 14 insertions(+), 21 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 51223b6..2997ccd 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -11,7 +11,6 @@ on: push: branches: - "main" - workflow_dispatch: env: @@ -68,8 +67,6 @@ jobs: version: 1.0 - name: Retrieve cache - # The retrieve cache job will run only, if the host is not a ubuntu-20.04 runner. - # GitHub hosted runners begin with 'Github Action' if: contains(runner.name, 'Github Action') uses: actions/cache@v3 env: diff --git a/.github/workflows/codechecker.yaml b/.github/workflows/codechecker.yaml index c96c5bf..f535b0a 100644 --- a/.github/workflows/codechecker.yaml +++ b/.github/workflows/codechecker.yaml @@ -81,8 +81,6 @@ jobs: version: 3.0 - name: Retrieve cache - # The retrieve cache job will run only, if the host is not a ubuntu-20.04 runner. - # GitHub hosted runners begin with 'Github Action' if: contains(runner.name, 'Github Action') uses: actions/cache@v3 env: diff --git a/.github/workflows/twister.yaml b/.github/workflows/twister.yaml index eda76a5..8e98884 100644 --- a/.github/workflows/twister.yaml +++ b/.github/workflows/twister.yaml @@ -12,9 +12,6 @@ env: jobs: twister-build: name: "Run Unit Tests" - # This version is a must, twister otherwise fails (some Python library - # depends on a specific version of libffi that is not present in the - # toolchain provided by nordic's toolchain manager). runs-on: self-hosted defaults: run: @@ -127,17 +124,19 @@ jobs: twister-test-results: name: "Publish Unit Tests Results" - needs: twister-build - if: always() - # These permissions must be set for the EnricoMi/publish-unit-test-result-action - # See https://github.com/EnricoMi/publish-unit-test-result-action#permissions + # WARNING: This must be run on Github Hosted Action Runners, as they allow the usage of Docker + # An alternative would be to create a custom Docker image with Docker-in-Docker enabled + + # This version is a must, twister otherwise fails (some Python library + # depends on a specific version of libffi that is not present in the + # toolchain provided by nordic's toolchain manager). + runs-on: ubuntu-22.04 permissions: contents: read issues: read checks: write - # WARNING: This must be run on Github Hosted Action Runners, as they allow the usage of Docker - # An alternative would be to create a custom Docker image with Docker-in-Docker enabled - runs-on: ubuntu-22.04 + needs: twister-build + if: always() steps: - name: Download Artefacts @@ -155,15 +154,14 @@ jobs: coverage-report: name: "Publish Coverage Report" - needs: twister-build # NOTE: This action is not compatible with "workflow_dispatch" event, so # it's not possible to run it manually. - if: ${{ github.event_name == 'push' || github.event_name == 'pull_request' }} - # Proper permissions are needed to create comments on PRs + runs-on: self-hosted permissions: issues: write pull-requests: write - runs-on: self-hosted + needs: twister-build + if: ${{ github.event_name == 'push' || github.event_name == 'pull_request' }} steps: - name: Download Artefacts diff --git a/README.md b/README.md index 2eba218..6ece1b5 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ of CI workflows for release automation. charge for this** to do it for you. - [ ] Create a new project on the CodeChecker server. You can also **contact person in charge** to do it for you. -- [ ] (Optional) Include the `twister-rpi.yaml` GitHub Actions workflow. Copy it from the `irnas-workflows-software/workflow-templates/rpi-twister-hil/.github/twister-rpi.yaml`. See the [README.md](scripts/rpi-jlink-server/README.md) for more information on the requirements and setup. +- [ ] (Optional) Include the `twister-rpi.yaml` GitHub Actions workflow for the on-target testing. Copy it from the `irnas-workflows-software/workflow-templates/rpi-twister-hil/.github/twister-rpi.yaml`. See the [README.md](scripts/rpi-jlink-server/README.md) for more information on the requirements and setup. - [ ] As a final step delete this checklist and commit changes. [repository naming scheme]: diff --git a/scripts/rpi-jlink-server/README.md b/scripts/rpi-jlink-server/README.md index 96fd67d..fc240b0 100644 --- a/scripts/rpi-jlink-server/README.md +++ b/scripts/rpi-jlink-server/README.md @@ -12,7 +12,7 @@ Documentation on how to set up the Raspberry Pi and a detailed explanation of th ## GitHub Actions Workflow The scripts mentioned are used by the `twister-rpi.yaml` GitHub Actions Workflow. -The workflow is not included in this repository, as it is opt-in. It can be found [here](...). To include it, you must copy the workflow file to your repository and add the following GitHub secrets: +The workflow is not included in this repository, as it is opt-in. To include it, you must copy the `twister-rpi.yaml` from the [linked repository](https://github.com/IRNAS/irnas-workflows-software/blob/main/workflow-templates/rpi-twister-hil/.github/twister-rpi.yaml) into `.github/workflows` folder inside your repository and add the following GitHub secrets: - RPI_IP - IP address of the Raspberry Pi running the JLinkRemoteServer.