Info

This repo is used to house any GitHub Actions that can be used across multiple repositories within a personal repo.

When using these in a GitHub action, you should not write a GH-Action from scratch unless its specific to the project you need, otherwise it should be placed here in this project.

---

Folder Structure

/github-actions/
  └── .github/workflows/
      ├── test.yaml
      ├── lint.yaml
      └── type-check.yaml

• Test: This is to run all PyTest tests for each repository
• Lint: Ruff is used for Linting and Checking the Project fies
• Type-Check: mypy is used for Type Checking:
  TODO: Implement TY from Astrol

---

Usage

you should have a ci.yaml file in your [project]/.github/workflows/ file. This file will serve as a catch-all for any common CI/CD workflows that NEED to run.

To use a workflow from this Repo, you will need to do the following in your /ci.yaml file jobs:

jobs:
  tests:
    uses: org-name/github-actions/.github/workflows/test.yaml@main

As you can see, you are able to call each GH-Action as required, so if you need the lint checker, you can just add a new jobs that looks at the /lint.yaml file

Optional Flags

• dir-path

  Enabled on: lint.yaml | test.yaml | type-check.yaml

  Allows you to specify a directory path to run Ruff, mypy, and pytest based on what you have implemented in your ci.yaml file.

    typer-checker:
      uses: JodyLS27/github-actions/.github/workflows/type-check.yaml@main
      with:
        dir-path: "app/" # Adding a specific path to check for `mypy`

---