cmlh / jake-github-action

Sonatype Jake for GitHub Actions

Jake for GitHub Actions

Run Sonatype Jake as part of your GitHub Actions workflow.

Inputs

packagesListFile

Default : packages.list

Optional command providing the path to a file containing the list of packages, typically the output from a conda list command.

jakeCommand

Default : ddt

You can customize this input with other commands and flags recognized by jake.

For example: ddt --quiet

Example Usage

The example below shows the use of a custom package list file.

name: Jake Github Action

on: [push]

jobs:
  build:
    runs-on: python:3.8-slim-buster
    steps:
    - name: Check out code
      uses: actions/checkout@v2

    - name: Run Jake
      uses: sonatype-nexus-community/jake-github-action@main
      with:
        packagesListFile: myPackages.list

Development

I found it useful to leverage the act project while developing this github action. This project allows you to push a branch to the github action repo, and use a commit hash to test the behavior of that branch. For example, a test project that uses the jake-github-action could have the following .github/workflows/jake.yml file. Notice the commit hash 950a8965cd37d8e14aaa6aebd6c0d71b4da71fa3 used below in the Scan step to run the development branch.

name: Jake

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:

  build:
    name: Build
    runs-on: python:3.8-slim-buster
    steps:
    - name: Check out code
      uses: actions/checkout@v2

    - name: Scan
      uses: sonatype-nexus-community/jake-github-action@950a8965cd37d8e14aaa6aebd6c0d71b4da71fa3
      with:
        jakeCommand: ddt --quiet

The Fine Print

It is worth noting that this is NOT SUPPORTED by Sonatype, and is a contribution of ours to the open source community (read: you!)

Remember:

• Use this contribution at the risk tolerance that you have
• Do NOT file Sonatype support tickets related to Nancy for GitHub Actions support in regard to this project
• DO file issues here on GitHub, so that the community can pitch in

Phew, that was easier than I thought. Last but not least of all:

Have fun creating and using Nancy for GitHub Actions, we are glad to have you here!

Getting help

Looking to contribute to our code but need some help? There's a few ways to get information:

• Chat with us on Gitter