Giter Site home page Giter Site logo

zupit / ritchie-formulas Goto Github PK

View Code? Open in Web Editor NEW
105.0 78.0 72.0 122.81 MB

This repository contains the community formulas that can be executed through Ritchie CLI once imported. This tool is an open source product that allows you to create, store and share any kind of automations, executing them through command lines, to run operations or start workflows ⚙️ 🖥 💡

Home Page: https://ritchiecli.io

License: Apache License 2.0

Dockerfile 3.61% Makefile 10.30% Go 30.94% Shell 15.12% Java 2.71% JavaScript 2.28% Python 8.38% HCL 0.14% Batchfile 15.83% PHP 0.19% Kotlin 3.46% Ruby 0.28% Swift 1.16% TypeScript 3.77% HTML 0.50% CSS 0.24% Rust 0.30% C# 0.42% PowerShell 0.14% Perl 0.22%
cli automation automationtool hacktoberfest good-first-issue opensource ritchie ritchie-formulas

ritchie-formulas's Introduction

The Ritchie CLI project has been archived by Zup Innovation. It might start again eventually; however, we won't deliver support for now.

CircleCI pre-commit

Table of contents

Ritchie's commons formula repository

This repository contains the community formulas ritchie-cli executes.

Create a new formula

You can create your own formula by following these steps:

Step 1. Fork the repository;

Step 2. Create a branch: git checkout -b <branch_name>;

Step 3. Create a new formula, using the forked repository as a Ritchie workspace: rit create formula If you need help check out how to create formulas on Ritchie on our documentation.

Step 4. Build and use the new formula: rit build formula or use --watch to keep observing changes on formula code live: rit build formula --watch

Step 5. Run pre-commit.sh to lint your code;

Step 6. Run go test -v ./.github/workflows/validation/... to test your code and formula structure. (GoLang Required);

Step 7. Commit your implementation;

Step 8. Push your branch;

Step 9. Open a pull request on the repository for analysis.

Add support to other languages on create formula command

The rit create formula command uses the /templates/create_formula folder to list the languages options. If you like to edit a language template or to add more language to create formula command, please access the Languages Template Tutorial tutorial.

For more information, access Ritchie's documentation.

Documentation

Contributing

Feel free to use, recommend improvements, or contribute to new implementations.

Check out our contributing guide to learn about our development process, how to suggest bug fixes and improvements.

Developer Certificate of Origin - DCO

This is a security layer for the project and for the developers. It is mandatory. Follow one of these two methods to add DCO to your commits:

1. Command line

Follow the steps:

Step 1: Configure your local git environment adding the same name and e-mail configured at your GitHub account. It helps to sign commits manually during reviews and suggestions.

git config --global user.name “Name”
git config --global user.email “[email protected]

Step 2: Add the Signed-off-by line with the '-s -S' flag in the git commit command:

$ git commit -s -S -m "This is my commit message"

2. GitHub website

You can also manually sign your commits during GitHub reviews and suggestions, follow the steps below:

Step 1: When the commit changes box opens, manually type or paste your signature in the comment box, see the examples:

e.g: Signed-off-by: Name < e-mail address >
$ git commit -m “My signed commit” Signed-off-by: username <email address>

For this method, your name and e-mail must be the same registered to your GitHub account.

Choose a branch

One of the first things to decide is which branch to base your work on. If you get confused, just ask and we will help you. If a reviewer realizes you have based your work on the wrong branch, we'll let you know so that you can rebase it.

Community

Feel free to reach out to us at:

Zup forum

ritchie-formulas's People

Contributors

afonsoaugusto avatar andressaabreuzup avatar antoniofilhozup avatar antonioolf avatar brunonmelo avatar chiaretto avatar denisvieiradev avatar dependabot[bot] avatar dmbarra avatar eduardorcury avatar ernelio avatar erneliojuniorzup avatar fabianofernandeszup avatar guillaumefalourd avatar henriquemoraes8 avatar henriquemoraeszup avatar isaiastavares avatar jenifersantoszup avatar joaodanielrufino avatar joaorufinozup avatar kaduartur avatar kelsoncarmozinezup avatar marcosgmgm avatar maurineimirandazup avatar rasouza avatar rodrigomedeirosf avatar sandokandias avatar victor-schumacher avatar viniciusramosdefaria avatar viniciussousazup avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

ritchie-formulas's Issues

Update RIT AWS CREATE BUCKET formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Create PERL template for RIT CREATE FORMULA command

Premisse

Suggestion

Why is it needed ?

  • It will make it easier for programmers to create formulas in PERL.

[FORMULA] Create new generic formulas

What would you like ?

Create a new generic formula for the community, manipulating any tool to create new use cases using Ritchie.

It can be anything that make sense to you, using API or creating something based on existing scripts. From Twitter to Google Cloud Platform, Selenium, Vault, Jira... everything is possible, you can be creative! 👍

Note: It would be great to be able to execute the formula through Docker, and to make it works on any OS.

Why is it needed ?

To show the community what the product offers and how it can resolve different kinds of problems.

Recommendation

Contribute opening one Pull Request for each formula .
This issue can be assigned to more than one collaborator, just leave a comment here.

  • Formula 1
  • Formula 2
  • Formula 3
  • Formula 4
  • Formula 5
  • Formula 6
  • Formula 7
  • Formula 8
  • Formula 9
  • Formula 10

Update RIT AWS ADD TERRAFORM-EKS formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT KAFKA CREATE TOPIC formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT DEMO COFFEE-PYTHON formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT DEMO COFFEE-SHELL formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT DOCKER GENERATE COMPOSE formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT ISTIO INIT formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT CLEAN-SWIFT UNINSTALL TEMPLATES formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT AWS UPDATE KUBECONFIG formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update Powershell Hello World template

What do you want ?

Why is this needed ?

  • It would help the Powershell programmer to have a template with an example of each kind of inputs available with Ritchie.

  • It would also help with Ritchie first contact as the demo formula (rit demo hello-world) will be the first formula executed by many users (following the documentation: https://docs.ritchiecli.io/how-to/how-to-run-formulas/commands)

Update Java11 Hello World template

What do you want ?

Why is this needed ?

  • It would help the Java11 programmer to have a template with an example of each kind of inputs available with Ritchie.

  • It would also help with Ritchie first contact as the demo formula (rit demo hello-world) will be the first formula executed by many users (following the documentation: https://docs.ritchiecli.io/how-to/how-to-run-formulas/commands)

Update Rust Hello World template

What do you want ?

Why is this needed ?

  • It would help the RUST programmer to have a template with an example of each kind of inputs available with Ritchie.

  • It would also help with Ritchie first contact as the demo formula (rit demo hello-world) will be the first formula executed by many users (following the documentation: https://docs.ritchiecli.io/how-to/how-to-run-formulas/commands)

[FEATURE] Awesome list for repos

What would you like to be added:
Have you guys considered creating an Awesome List for different ritchie formula repos?
Why is this needed:
Since your repo management is not centralized, which is good, we could maintain a curated list so users could submit (through PRs) and search for formulas there.

Ideally, since you would be the ones to assessing if the formula is actually good enough or not to be accepted in the list, you should be the owners and contributors of this repo/list, but if you're not very sure how to do this I can prepare a valid one and include you as official contributors.

I'm glad to hear your opinion on top of that before taking into action

Update Java8 Hello World template

What do you want ?

Why is this needed ?

  • It would help the Java8 programmer to have a template with an example of each kind of inputs available with Ritchie.

  • It would also help with Ritchie first contact as the demo formula (rit demo hello-world) will be the first formula executed by many users (following the documentation: https://docs.ritchiecli.io/how-to/how-to-run-formulas/commands)

Update RIT AWS GENERATE TERRAFORM-PROJECT formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT DEMO COFFEE-JAVA formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT KAFKA PRODUCE MESSAGE formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update PHP Hello World template

What do you want ?

Why is this needed ?

  • It would help the PHP programmer to have a template with an example of each kind of inputs available with Ritchie.

  • It would also help with Ritchie first contact as the demo formula (rit demo hello-world) will be the first formula executed by many users (following the documentation: https://docs.ritchiecli.io/how-to/how-to-run-formulas/commands)

[FORMULA] Messaging Queue Mock builder

What would you like to be added:

  • I'd like to ask for a mock queue command, which would make easier to create scenarios for the consumer/producer services patterns.
  • This would be great for: Developer, Debugging, Testing (Manually or CI integrated - E2E testing)
  • Popular queues/messaging: Sqs, Kafka, ZeroMQ, RabbitMq, AMQP

Instructions (Using SQS as example):

As a User, I'd like to create a FIFO queue for testing a producer integration with SalesForce.

What I'd need to do without ritchie:

  • Knowledge in AWS CLI
  • Knowledge in docker
  • Find out an sqs container (alpine/sqs) and creating a yaml for that
  • Knowledge to parse my JSON files to the AWS CLI add the messages to the queue
  • If I do not know the previous step, I'd need to run the producer and insert it

How ritchie can help me:

  • Command name (suggestion) rit create mock queue sqs
  • Would read a sqs-config.json

// Suggesting a generic config file, you could use the same JSON schema template for kafka, i.e: kafka-config.json
sqs-config.json

{
	docker: {
		port
		volume
		etc ..
	}
	queue: {
		type: ENUM -> SQS_STANDARD|SQS_FIFO|KAFKA_TOPIC|ZMQ_DEALER|ZMQ_SUBSCRIBER|ZMQ_TOPIC
	}
	data: [
		{key: value} <= Producer data that would be sent to the queue
	]
}

The data would be inserted in my SQS FIFO Queue, so I'd just need to RUN my producer and checkout the logs / SalesForce

Why is this needed:

  • This could save a lot of trouble/time setting up a Queue for testing & developing purposes
  • This could be integrated on a CI for E2E testing
  • Less infrastructure knowledge required for the developer/tester

Update RIT CLEAN-SWIFT INSTALL TEMPLATES formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT AWS DELETE BUCKET formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT AWS ADD TERRAFORM-VPC formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Create TYPESCRIPT template for RIT CREATE FORMULA command

Premisse

Suggestion

Why is it needed ?

  • It will make it easier for programmers to create formulas in Typescript.

[BUG] Credentials in are presented in plain text when presenting an error

What happened:
When using the github credentials to create a repository (rit github create repo) and the process happens an authentication error they are presented in plain text next to the error.

Captura de tela de 2020-08-26 15-56-00

What you expected to happen:
Display an authentication error with the credentials, but without writing them, but I don't know if this is a bug or expected behavior.

How to reproduce it (as minimally and precisely as possible):

rit set credential # usign user: testUser, email: testEmail and password: testPassword
rit github create repo # using an private repo

Anything else we need to know?:

Environment:

  • Ritchie version: 2.0.4

  • Operating System: Ubuntu 18.04.5 LTS

  • Network plugin / Tool and version (if this is a network-related / tool bug):

  • Others:

Update RIT AWS LIST BUCKET formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT DEMO COFFEE-NODE formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Create KOTLIN template for RIT CREATE FORMULA command

Premisse

Suggestion

Why is it needed ?

  • It will make it easier for programmers to create formulas in Kotlin.

[FEATURE] tree.json -> tree.yaml

What would you like to be added:

I think moving the JSON structure to a YAML would be more of a benefit in terms of visualization and adopting a Map structure instead of Array

Note: "The code wise", "Command Listing" is how I see the logic behind, didn't checked the source code before suggesting this

Code wise: Array[i].parent > Recursive til parent command (validation)
Command Listing: for ... { add(parent.contains(key)) }

Regular JSON structure

{
   "commands":[
      {
         "usage":"aws",
         "help":"Apply Aws objects",
         "parent":"root"
      },
      {
         "usage":"apply",
         "help":"Apply Aws objects",
         "parent":"root_aws"
      },
      {
         "usage":"terraform",
         "help":"Apply Aws terraform objects",
         "formula":{
            "path":"aws/terraform",
            "bin":"terraform-cli-${so}",
            "repoUrl":"http://ritchie-cli-bucket152849730126474.s3-website-sa-east-1.amazonaws.com/formulas/aws/terraform"
         },
         "parent":"root_aws_apply"
      }
   ],
   "version":"1.0.0-dev"
}

Code wise: commands->aws->terraform
for sub commands: commands->aws->terraform->commands->load

Command listing: key.child, key.child.values()

New YAML structure

version: 1.0.0-dev
commands:
  aws:
    help: Apply Aws objects
    commands:
      apply:
        help: Apply Aws objects
      terraform:
        help: Apply Aws terraform objects
        formula:
          path: aws/terraform
          bin: 'terraform-cli-${so}'
          repoUrl: http://ritchie-cli-bucket152849730126474.s3-website-sa-east-1.amazonaws.com/formulas/aws/terraform

Why is this needed:

  • The current structure makes you search over an array to find whatever you need, also you need to build a parent key using a snake_case every, which can be avoiding by just using its command key like the YAML example

Update Node Hello World template

What do you want ?

Why is this needed ?

  • It would help the Node programmer to have a template with an example of each kind of inputs available with Ritchie.

  • It would also help with Ritchie first contact as the demo formula (rit demo hello-world) will be the first formula executed by many users (following the documentation: https://docs.ritchiecli.io/how-to/how-to-run-formulas/commands)

Update RIT GITHUB UPDATE FORK formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

[FEATURE] Change the PullRequest template of formulas

What would you like to be added:
Change the PullRequest template of formulas for the user to inform if the change is Major, Minor or Patch, to follow the Weekly version.

Why is this needed:
So that it is possible to generate a release taking this into account.

Update RIT AWS APPLY TERRAFORM formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Create SWIFT template for RIT CREATE FORMULA command

Premisse

Suggestion

Why is it needed ?

  • It will make it easier for programmers to create formulas in SWIFT.

Update RIT AWS SET CONTEXT formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update Python template to support dependencies

What would you like to be added:
Change python template to add support to dependencies

Why is this needed:
Today the python template not create a code that support requirements.txt so the user have to change the makefile and build.bat to support this dependencies

Update RIT CIRCLECI ADD ENV formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update C# Hello World template

What do you want ?

Why is this needed ?

  • It would help the C# programmer to have a template with an example of each kind of inputs available with Ritchie.

  • It would also help with Ritchie first contact as the demo formula (rit demo hello-world) will be the first formula executed by many users (following the documentation: https://docs.ritchiecli.io/how-to/how-to-run-formulas/commands)

Update Python3 Hello World template

What do you want ?

Why is this needed ?

  • It would help the Python3 programmer to have a template with an example of each kind of inputs available with Ritchie.

  • It would also help with Ritchie first contact as the demo formula (rit demo hello-world) will be the first formula executed by many users (following the documentation: https://docs.ritchiecli.io/how-to/how-to-run-formulas/commands)

Update RIT GITHUB SEARCH HANDBOOK formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update Shell Hello World template

What do you want ?

Why is this needed ?

  • It would help the Shell programmer to have a template with an example of each kind of inputs available with Ritchie.

  • It would also help with Ritchie first contact as the demo formula (rit demo hello-world) will be the first formula executed by many users (following the documentation: https://docs.ritchiecli.io/how-to/how-to-run-formulas/commands)

Update RIT KAFKA CONSUME MESSAGE formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT AWS CLEAN BUCKET formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT DEMO COFFEE-GO formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT GITLAB PUBLISH REPO formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT GITHUB NAVIGATE HANDBOOK formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Update RIT BEAGLE GENERATE SCAFFOLD formula README

What would you like ?

Why is this needed ?

  • With the Ritchie Portal (ongoing) those READMEs will be used to share formulas information with the community, and the better they are, the easiest it will be for the community to use them.

Examples

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.