Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/guillaumefalourd/formulas-github

Ritchie CLI formulas interacting with Github APIs :octocat:
https://github.com/guillaumefalourd/formulas-github

formulas github hacktoberfest ritchie-cli

Last synced: 3 months ago
JSON representation

Ritchie CLI formulas interacting with Github APIs :octocat:

Host: GitHub
URL: https://github.com/guillaumefalourd/formulas-github
Owner: GuillaumeFalourd
License: apache-2.0
Created: 2021-01-26T15:05:05.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2023-05-01T16:31:49.000Z (over 1 year ago)
Last Synced: 2024-10-12T14:39:00.252Z (3 months ago)
Topics: formulas, github, hacktoberfest, ritchie-cli
Language: Python
Homepage: https://ritchiecli.io
Size: 4.99 MB
Stars: 35
Watchers: 3
Forks: 6
Open Issues: 3
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Formulas Github

[![Security Pipeline](https://github.com/GuillaumeFalourd/formulas-github/actions/workflows/security_pipeline.yml/badge.svg)](https://github.com/GuillaumeFalourd/formulas-github/actions/workflows/security_pipeline.yml) [![Super Linter](https://github.com/GuillaumeFalourd/formulas-github/actions/workflows/super-linter.yml/badge.svg)](https://github.com/GuillaumeFalourd/formulas-github/actions/workflows/super-linter.yml)

title

## 📚 Documentation

This repository contains Ritchie formulas which can be executed by [ritchie-cli](https://github.com/ZupIT/ritchie-cli).

- [Ritchie CLI documentation](https://docs.ritchiecli.io)
- [Step by step to create a Github profile with Ritchie CLI](https://bit.ly/devtoritgithubcreateprofile)

## 📊 Use Formulas

To import this repository, you need [Ritchie CLI installed](https://docs.ritchiecli.io/getting-started/installation)

Then, you can use the `rit add repo` command manually, or execute the command line below directly on your terminal (since CLI version 2.8.0):

```bash
rit add repo --provider="Github" --name="formulas-github" --repoUrl="https://github.com/GuillaumeFalourd/formulas-github" --priority=1
```

Finally, you can check if the repository has been imported correctly by executing the `rit list repo` command.

## 🔎 Formulas available on this repository

### 🗃 Repositories

- [Add Github Actions](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/add/github-actions): `rit github add github-actions`

*Formula to add a github-actions workflow to a specific repository*

- [Add Github Secret](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/add/secret): `rit github add secret`

*Formula to add a new Secret to a specific repository*

- [Create Github Repository](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/create/repo): `rit github create repo`

*Formula to create a new repository on the user account*

- [Create Github Issue](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/create/issue): `rit github create issue`

*Formula to create a new issue on any repository the PAT has access to*

- [Delete Github Secrets](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/delete/secrets): `rit github delete secrets`

*Formula to delete Secrets from a specific repository*

- [Delete Github Repository](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/delete/repo): `rit github delete repo`

*Formula to delete a repository from the user account*

- [Delete workflow logs](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/delete/workflow-logs): `rit github delete workflow-logs`

*Formula to delete all workflow logs from a specific workflow file (100 logs removed at each execution)*

- [Get Github Repo Details](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/get/repo): `rit github get repo`

*Formula to get datas and contribution insights from a specific repository*

- [Get Github Repositories Insights](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/get/insights): `rit github get insights`

*Formula to generate a CSV report with insights from the user repositories*

- [Create Github Branch](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/create/branch): `rit github create branch`

*Formula to create a new branch on a specific repository*

- [Trigger Github Actions Workflow](https://github.com/GuillaumeFalourd/formulas-github/blob/master/github/trigger/workflow/README.md): `rit github trigger workflow`

*Formula to trigger through a command line a Github Actions workflow using a `repository_dispatch` or a `workflow_dispatch` event, on any repository the user has access to, with or without `client_payload` / `inputs`.*

- [Update Github Repo Default Branch](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/update/repo/default-branch): `rit github update repo default-branch`

*Formula to update the default branch of a specific repository*

- [Update Many Github Repo Default Branches](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/update/many-default-branches): `rit github update many-default-branches`

*Formula to update (all) repositories default branches from a specific user account*

### 🧑‍💻 Users

- [Create Github Profile](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/create/profile): `rit github create profile`

*Formula to create a Github README file for user profile repository*

- [Generate Github Release](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/generate/release): `rit github generate release`

*Formula to generate a new release tag on a specific repository*

- [Get Github User Details](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/get/user): `rit github get user`

*Formula to get insights from a specific Github user*

- [Get Github User Email](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/get/user-email): `rit github get user-email`

*Formula to get the email associated to a Github username*

- [Get Github User Billing](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/get/user-billing): `rit github get user-billing`

*Formula to get the billing datas associated to the Github username*

- [Add Github Collaborator](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/add/collaborator): `rit github add collaborator`

*Formula to add a new collaborator to a specific repository*

- [Delete Github Collaborator](https://github.com/GuillaumeFalourd/formulas-github/tree/master/github/delete/collaborator): `rit github delete collaborator`

## ♻️ Contribute to the repository with your formulas

### 🆕 Creating formulas

1. Fork and clone the repository
2. Create a branch: `git checkout -b `
3. Check the step by step of [how to create formulas on Ritchie](https://docs.ritchiecli.io/tutorials/formulas/how-to-create-formulas)
4. Add your formulas to the repository
and commit your implementation: `git commit -m '`
5. Push your branch: `git push origin /`
6. Open a pull request on the repository for analysis.

### 🆒 Updating Formulas

1. Fork and clone the repository
2. Create a branch: `git checkout -b `
3. Add the cloned repository to your workspaces (`rit add workspace`) with a highest priority (for example: 1).
4. Check the step by step of [how to implement formulas on Ritchie](https://docs.ritchiecli.io/tutorials/formulas/how-to-implement-a-formula)
and commit your implementation: `git commit -m '`
5. Push your branch: `git push origin /`
6. Open a pull request on the repository for analysis.

- [Contribute to Ritchie community](https://github.com/ZupIT/ritchie-formulas/blob/master/CONTRIBUTING.md)

### Contributors

(Made with [contributors-img](https://contrib.rocks))