guillaumefalourd / ritchie-action-python

Ritchie CLI github action for PYTHON 🤖

ritchie-action-python

This Github action works for Ritchie CLI formulas implemented in Python.

How to use this action?

Field	Mandatory	Observation
rit-repo-url	YES	Formula repository URL
rit-formula-command	YES	Formula command with input flags

Executing a formula from a PUBLIC repository

name: Action workflow

on:
 push:
 workflow_dispatch:

jobs:
  action_job:
    runs-on: ubuntu-latest
    name: Ritchie Action
    steps:
    - name: Run Ritchie Action Command with PUBLIC repository
      uses: GuillaumeFalourd/[email protected]
      with:
        rit-repo-url: https://github.com/ZupIT/ritchie-formulas-demo
        rit-formula-command: rit demo coffee-python --rit_name=Dennis --rit_coffee_type=espresso --rit_delivery=false

Where:

• rit-repo-url is the Github formula public repository url where the formula is located.
• rit-formula-command is the formula command (with input flags if needed) implemented in python.

Executing a formula from a PRIVATE repository

name: Action workflow

on:
 push:
 workflow_dispatch:

jobs:
  action_job:
    runs-on: ubuntu-latest
    name: Ritchie Action
    steps:
    - name: Run Ritchie Action Command with PRIVATE repository
      uses: GuillaumeFalourd/[email protected]
      env:
        CREDENTIAL_GITHUB_USERNAME: ${{ secrets.CREDENTIAL_GITHUB_USERNAME }}
        CREDENTIAL_GITHUB_TOKEN: ${{ secrets.CREDENTIAL_GITHUB_TOKEN }}
      with:
        rit-repo-url: https://github.com/GuillaumeFalourd/formulas-training
        rit-formula-command: rit python math sum numbers --number_one=1 --number_two=2

Where:

• CREDENTIAL_GITHUB_USERNAME is the GITHUB USERNAME saved as a secret.
• CREDENTIAL_GITHUB_TOKEN is the GITHUB PERSONAL ACCESS TOKEN with full repository access saved as a secret.
• rit-repo-url is the Github formula private repository url where the formula is located.
• rit-formula-command is the formula command (with input flags if needed) implemented in Shell.