https://github.com/common-workflow-lab/upload-conformance-badges

Action for uploading CWL conformance badges
https://github.com/common-workflow-lab/upload-conformance-badges

common-workflow-language commonwl cwl

Last synced: 4 months ago
JSON representation

Action for uploading CWL conformance badges

• Host: GitHub
• URL: https://github.com/common-workflow-lab/upload-conformance-badges
• Owner: common-workflow-lab
• License: apache-2.0
• Created: 2022-02-01T06:39:01.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-25T23:22:43.000Z (almost 2 years ago)
• Last Synced: 2025-09-20T17:50:49.951Z (9 months ago)
• Topics: common-workflow-language, commonwl, cwl
• Homepage:
• Size: 32.2 KB
• Stars: 0
• Watchers: 9
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# upload-conformance-badges

It is a custom Github Action for uploading CWL conformance badges to a specified repository.

## Example

```yaml

jobs:

  conformance:

    runs-on: ubuntu-latest

    steps:

      ...

      - name: Run conformance tests

        id: run-conformance

        uses: common-workflow-lab/run-conformance-tests@v1

        with:

          cwlVersion: v1.0

          runner: your-runner

          timeout: 30

          skip-python-install: true

      - name: Save badges

        if: success() && github.event_name == 'push' # upload badges when this action is invoked by `push` event

        uses: common-workflow-lab/upload-conformance-badges@v1

        with:

          cwlVersion: v1.0

          runner-name: your-runner

          badgedir: ${{ steps.run-conformance.outputs.badgedir }}

          repository: ${{ github.repository_owner }}/conformance

          upload-default-branch: true

          ssh-key: ${{ secrets.CONFORMANCE_KEY }}

```

## Input parameters

| Parameters | Required | Default | Description |

|---|---|---|---|

| `cwlVersion` | true | - | target CWL version |

| `runner-name` | true | - | name of CWL runner |

| `badgedir` | true | - | full path to the directory that stores conformance badges |

| `repository` | true | - | repository (in the form of `owner/repo`) to store badges |

| `upload-default-branch` | false | false | whether uploading the result of HEAD in the default branch |

| `upload-markdown-reports` | false | false | whether uploading the markdown reports in addition to the conformance badges |

| `ssh-key` | true | - | ssh key to commit the repository specified in the `repository` field. See [deploy keys](https://docs.github.com/en/developers/overview/managing-deploy-keys#deploy-keys) for details |

This action has no output parameters.