BiocActions

Develop and host GitHub actions for Bioconductor

Contributions

Add a new action

Note that using actions in this package is addressed below in the Usage section

By pull request

New actions can be added to inst/actions/name-of-action/ in this package.

All new actions should contain at least:

• README.md (required, including documentation of inputs and outputs)
• Dockerfile (if the action is container-based)
• action.yml (must have that name)

By suggesting a new action

Someone else must implement actions suggested by issue. Therefore, these are best considered suggestions and not really direct requests.

• Create an issue proposing a new action

Usage

To use one or more of the BiocActions in your own package, create a workflow file that looks something like this.

on: [push]

jobs:
  hello_world_job:
    runs-on: ubuntu-latest
    name: A job to say hello
    steps:
    - name: Hello world action step
      id: hello
      uses: seandavi/BiocActions/inst/actions/hello-world-docker-action@master
      with:
        who-to-greet: 'Mona the Octocat'
    # Use the output from the `hello` step
    - name: Get the output time
      run: echo "The time was ${{ steps.hello.outputs.time }}"

As a reminder, in your own package workflows are always placed in .github/workflows/workflow_name.yml. An example repository that uses this idea is here.