julioc98 / formulas-github

Ritchie CLI formulas interacting with Github APIs :octocat:

Home Page:https://ritchiecli.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Security Pipeline

Formulas Github

title

πŸ“š Documentation

This repository contains Ritchie formulas which can be executed by ritchie-cli.

πŸ“Š Use Formulas

To import this repository, you need Ritchie CLI installed

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):

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

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

Formula to add a new Secret to a specific repository

Formula to create a new repository on the user account

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

Formula to delete Secrets from a specific repository

Formula to delete a repository from the user account

Formula to get datas and contribution insights from a specific repository

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

Formula to create a new branch on a specific repository

Formula to update the default branch of a specific repository

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

πŸ§‘β€πŸ’» Users

Formula to create a Github README file for user profile repository

Formula to generate a new release tag on a specific repository

Formula to get insights from a specific Github user

Formula to get the email associated to a Github username

Formula to get the billing datas associated to the Github username

Formula to add a new collaborator to a specific repository

♻️ Contribute to the repository with your formulas

πŸ†• Creating formulas

  1. Fork and clone the repository
  2. Create a branch: git checkout -b <branch_name>
  3. Check the step by step of how to create formulas on Ritchie
  4. Add your formulas to the repository and commit your implementation: git commit -m '<commit_message>
  5. Push your branch: git push origin <project_name>/<location>
  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 <branch_name>
  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 and commit your implementation: git commit -m '<commit_message>
  5. Push your branch: git push origin <project_name>/<location>
  6. Open a pull request on the repository for analysis.

Contributors

(Made with contributors-img)

About

Ritchie CLI formulas interacting with Github APIs :octocat:

https://ritchiecli.io

License:Apache License 2.0


Languages

Language:Python 56.0%Language:Makefile 18.1%Language:Batchfile 16.2%Language:Dockerfile 5.0%Language:Shell 4.6%