Formulas Github

📚 Documentation

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

• Ritchie CLI documentation
• Step by step to create a Github profile with 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

• Add Github Actions: rit github add github-actions

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

• Add Github Secret: rit github add secret

Formula to add a new Secret to a specific repository

• Create Github Repository: rit github create repo

Formula to create a new repository on the user account

• Create Github Issue: rit github create issue

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

• Delete Github Secrets: rit github delete secrets

Formula to delete Secrets from a specific repository

• Delete Github Repository: rit github delete repo

Formula to delete a repository from the user account

• 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: rit github get repo

Formula to get datas and contribution insights from a specific repository

• Get Github Repositories Insights: rit github get insights

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

• Create Github Branch: rit github create branch

Formula to create a new branch on a specific repository

• Trigger Github Actions Workflow: 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: rit github update repo default-branch

Formula to update the default branch of a specific repository

• Update Many Github Repo Default Branches: rit github update many-default-branches

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

🧑‍💻 Users

• Create Github Profile: rit github create profile

Formula to create a Github README file for user profile repository

• Generate Github Release: rit github generate release

Formula to generate a new release tag on a specific repository

• Get Github User Details: rit github get user

Formula to get insights from a specific Github user

• Get Github User Email: rit github get user-email

Formula to get the email associated to a Github username

• Get Github User Billing: rit github get user-billing

Formula to get the billing datas associated to the Github username

• Add Github Collaborator: rit github add collaborator

Formula to add a new collaborator to a specific repository

• Delete Github 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 <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.

• Contribute to Ritchie community

Contributors

(Made with contributors-img)