https://github.com/ymyzk/run-tox-gh-actions

(EXPERIMENTAL) A composite GitHub Actions run steps for running tox-gh-actions
https://github.com/ymyzk/run-tox-gh-actions

actions

Last synced: 2 months ago
JSON representation

(EXPERIMENTAL) A composite GitHub Actions run steps for running tox-gh-actions

• Host: GitHub
• URL: https://github.com/ymyzk/run-tox-gh-actions
• Owner: ymyzk
• License: mit
• Created: 2021-01-17T06:23:10.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-08-17T15:08:40.000Z (over 1 year ago)
• Last Synced: 2024-05-01T22:52:28.758Z (8 months ago)
• Topics: actions
• Homepage:
• Size: 10.7 KB
• Stars: 5
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# run-tox-gh-actions

**run-tox-gh-actions** is a [composite run steps action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-run-steps-action) which makes it easier to install and run tox with [tox-gh-actions](https://github.com/ymyzk/tox-gh-actions) plugin on GitHub Actions.

## Features

* Install tox and tox-gh-actions

* Run tox with tox-gh-actions

## Usage

1. Follow [README of tox-gh-actions](https://github.com/ymyzk/tox-gh-actions) to configure tox and tox-gh-actions

2. Use this step in your GitHub Actions workflow

## Basic Example

In `.github/workflows/.yml`, you can use this step like

```yaml

name: CI

on:

  pull_request:

  push:

    branches:

      - main

jobs:

  build:

    runs-on: ubuntu-latest

    strategy:

      matrix:

        python-version: [3.6, 3.7, 3.8, 3.9, pypy3]

    steps:

    - uses: actions/checkout@v3

    - name: Set up Python ${{ matrix.python-version }}

      uses: actions/setup-python@v3

      with:

        python-version: ${{ matrix.python-version }}

    # Instead of installing and running tox and tox-gh-actions,

    # you can simply use this composite run steps action.

    - name: Run tox with tox-gh-actions

      uses: ymyzk/run-tox-gh-actions@main

```

## Available Inputs

You can give additional inputs to tune behavior of the run-tox-gh-actions.

See [action.yml](./action.yml) for all available inputs.

```yaml

jobs:

  build:

    steps:

    - name: Run tox with tox-gh-actions

      uses: ymyzk/run-tox-gh-actions@main

      with:

        tox-version: "==3.20.1"

```