https://github.com/guillaumefalourd/ritchie-action-python

Ritchie CLI github action for PYTHON 🤖
https://github.com/guillaumefalourd/ritchie-action-python

github-actions python ritchie-cli

Last synced: about 2 months ago
JSON representation

Ritchie CLI github action for PYTHON 🤖

• Host: GitHub
• URL: https://github.com/guillaumefalourd/ritchie-action-python
• Owner: GuillaumeFalourd
• License: apache-2.0
• Created: 2021-03-29T13:32:07.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-05-14T14:50:27.000Z (over 3 years ago)
• Last Synced: 2024-10-18T02:27:59.254Z (3 months ago)
• Topics: github-actions, python, ritchie-cli
• Language: Shell
• Homepage: https://ritchiecli.io/
• Size: 18.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ritchie-action-python



This Github action works for [Ritchie CLI](https://ritchiecli.io/) formulas implemented in **Python**.

[![Action workflow (PUBLIC)](https://github.com/GuillaumeFalourd/ritchie-action-python/actions/workflows/public-repo-demo-workflow.yml/badge.svg)](https://github.com/GuillaumeFalourd/ritchie-action-python/actions/workflows/public-repo-demo-workflow.yml)

[![Action workflow (PRIVATE)](https://github.com/GuillaumeFalourd/ritchie-action-python/actions/workflows/private-repo-demo-workflow.yml/badge.svg)](https://github.com/GuillaumeFalourd/ritchie-action-python/actions/workflows/private-repo-demo-workflow.yml)

## 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

```bash

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

```bash

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](https://docs.github.com/en/actions/reference/encrypted-secrets).

- `CREDENTIAL_GITHUB_TOKEN` is the [GITHUB PERSONAL ACCESS TOKEN](https://github.com/settings/tokens) with full repository access saved [as a secret](https://docs.github.com/en/actions/reference/encrypted-secrets).

- `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.