Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Github Action to run Ritchie CLI commands on any OS runner ⚙️🖥
https://github.com/guillaumefalourd/ritchie-cli-action

github-actions ritchie-cli ritchie-formulas utilities

Last synced: about 2 months ago
JSON representation

Github Action to run Ritchie CLI commands on any OS runner ⚙️🖥

Host: GitHub
URL: https://github.com/guillaumefalourd/ritchie-cli-action
Owner: GuillaumeFalourd
License: apache-2.0
Created: 2021-06-23T16:26:11.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-08-31T15:14:39.000Z (over 3 years ago)
Last Synced: 2024-10-19T16:56:25.639Z (2 months ago)
Topics: github-actions, ritchie-cli, ritchie-formulas, utilities
Homepage: https://ritchiecli.io
Size: 79.1 KB
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# Ritchie CLI Action

[![Action test on Ubuntu](https://github.com/GuillaumeFalourd/ritchie-cli-action/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/GuillaumeFalourd/ritchie-cli-action/actions/workflows/ubuntu.yml) [![Action test on MacOs](https://github.com/GuillaumeFalourd/ritchie-cli-action/actions/workflows/macos.yml/badge.svg)](https://github.com/GuillaumeFalourd/ritchie-cli-action/actions/workflows/macos.yml) [![Action test on Windows](https://github.com/GuillaumeFalourd/ritchie-cli-action/actions/workflows/windows.yml/badge.svg)](https://github.com/GuillaumeFalourd/ritchie-cli-action/actions/workflows/windows.yml)

title

Github Action to run [Ritchie CLI](https://ritchiecli.io) commands on any OS runner ⚙️🖥

* * *

## 📚 Usage

[![Public workflows that use this action.](https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DGuillaumeFalourd%2Fritchie-cli-action%26badge%3Dtrue)](https://github.com/search?o=desc&q=GuillaumeFalourd+ritchie-cli-action+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code) ☞ [Who is using this action? 🧑‍💻](https://github.com/search?q=GuillaumeFalourd+ritchie-cli-action+path%3A.github%2Fworkflows+language%3AYAML&type=code)

### Requirements

⚠️ The [`actions/checkout`](https://github.com/actions/checkout) is mandatory to use this action on **`WINDOWS RUNNER`**, as the repository root is used to install and execute Ritchie binary.

⚠️ [`Actions to setup environments`](https://github.com/marketplace?type=actions&query=setup+env+) may be necessary to use this action depending on the `runner` or the `programming language` that will be used to run and build the formula. For example:

- [setup-node](https://github.com/marketplace/actions/setup-node-js-environment) for formula coded using Node,
- [setup-go](https://github.com/marketplace/actions/setup-go-environment) for formula code using Golang,
- [setup-java](https://github.com/marketplace/actions/setup-java-jdk) for formula coded using Java
- ...

* * *

## ♻️ Scenarios

### 1️⃣ Run formula from `PUBLIC` Github repository

**Unix**

```yaml
steps:
- uses: # setup for formula programming language if needed
- uses: GuillaumeFalourd/ritchie-cli-action@v1
with:
rit_formula_command: rit demo coffee-python --rit_name=Dennis --rit_coffee_type=espresso --rit_delivery=false
rit_repo_url: https://github.com/ZupIT/ritchie-formulas-demo
```

**Windows**

```yaml
steps:
- uses: actions/[email protected]
- uses: # setup for formula programming language if needed
- uses: GuillaumeFalourd/ritchie-cli-action@v1
with:
rit_formula_command: ./rit.exe demo coffee-python --rit_name=Dennis --rit_coffee_type=espresso --rit_delivery=false
rit_repo_url: https://github.com/ZupIT/ritchie-formulas-demo
```

### 2️⃣ Run formula from `PRIVATE` Github repository

**Unix**

```yaml
steps:
- uses: # setup for formula programming language if needed
- uses: GuillaumeFalourd/ritchie-cli-action@v1
with:
rit_formula_command: rit python math sum numbers --number_one=1 --number_two=2
rit_repo_url: https://github.com/GuillaumeFalourd/formulas-training
access_token: ${{ secrets.ACCESS_TOKEN }}
```

**Windows**

```yaml
steps:
- uses: actions/[email protected]
- uses: # setup for formula programming language if needed
- uses: GuillaumeFalourd/ritchie-cli-action@v1
with:
rit_formula_command: ./rit.exe python math sum numbers --number_one=1 --number_two=2
rit_repo_url: https://github.com/GuillaumeFalourd/formulas-training
access_token: ${{ secrets.ACCESS_TOKEN }}
```

* * *

## ▶️ Action Inputs

Field | Mandatory | Observation
------------ | ------------ | -------------
**rit_formula_command** | YES | Ritchie formula command line.
_e.g: `rit demo hello-world`_ (**UNIX**)
_e.g: `./rit.exe demo hello-world`_ (**WINDOWS**)
**rit_repo_url** | YES | Github repository where the formula's code is located.
_e.g: `https://github.com/ZupIT/ritchie-formulas-demo`_
**access_token** | NO | Github [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) with access to the private formulas repository to import.

_Note: Formula's **generated outputs (files or directories)** will be located at the repository root (`$GITHUB_WORKSPACE`)._

* * *

## 🤝 Contributing

☞ [Guidelines](https://github.com/GuillaumeFalourd/ritchie-cli-action/blob/main/CONTRIBUTING.md)

## 🏅 Licensed

☞ This repository uses the [Apache License 2.0](https://github.com/GuillaumeFalourd/aws-cliaction/blob/main/LICENSE)