https://github.com/hrshdhgd/workflows

Quality control GitHub action project
https://github.com/hrshdhgd/workflows

Last synced: 14 days ago
JSON representation

Quality control GitHub action project

• Host: GitHub
• URL: https://github.com/hrshdhgd/workflows
• Owner: hrshdhgd
• License: mit
• Created: 2022-11-01T20:46:52.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-02T22:13:58.000Z (about 2 years ago)
• Last Synced: 2024-11-05T20:05:39.880Z (2 months ago)
• Language: Shell
• Size: 35.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Workflows

This project is a combination of three GitHub Action Workflows commonly used in BBOP projects.

- Quality Check (qc)

- Autodeployment of documentation (docs)

- PyPI Release (pypi)

# Usage

## For qc

Assuming `build` in the workflow looks like this:

```

build:

    runs-on: ubuntu-latest

    strategy:

        matrix:

        python-version: [ "3.9", "3.10" ]

```

```

- uses: hrshdhgd/qc-action@main

  with:

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

    use-tox: true

    workflow-type: qc

```

## For docs (Using Sphinx only for now)

```

- uses: hrshdhgd/qc-action@main

  with:

    python-versions: "3.9"

    workflow-type: docs

    token: ${{ secrets.GH_TOKEN }}

```

## For PyPI

```

- uses: hrshdhgd/qc-action@main

  with:

    python-versions: "3.9"

    workflow-type: pypi

    token: ${{ secrets.PYPI_TOKEN }}

```

# Examples of complete workflow configurations:

 - [qc](https://github.com/hrshdhgd/workflow-test/blob/main/.github/workflows/qc.yml)

 - [docs](https://github.com/hrshdhgd/workflow-test/blob/main/.github/workflows/docs.yml)

 - [pypi](https://github.com/hrshdhgd/workflow-test/tree/main/.github/workflows)