Skip to content

PedroTroller/octokit-orb

Repository files navigation

Logo

pedrotroller/octokit-orb

CircleCI

Use @octokit/rest with a CircleCI orb


-----------------------------------------------------

➤ Table of Contents

-----------------------------------------------------

➤ Ambition

The ambition of this project is to try to bring to CircleCI the functionality that actions/github-script brings to Github Actions. This porting is done through a CircleCI Orb.

-----------------------------------------------------

➤ How to use ?

Read the documentation from the CircleCI Orb Registry.

-----------------------------------------------------

➤ Documentation

@appnest/readme

This application use the awesome @appnest/readme package to generate it's documentation.

How to rebuild the documentation ?

You need to install nodejs and then, juste run npx @appnest/readme generate.

-----------------------------------------------------

➤ You want to contribute ? Welcome !

Commit name convention

This project follow the Conventional Commits specification, so please, respect the convention. The versionning system depends on this convention.

Describe the content of your contribution

With just a short description of the problem or the need, it's simpler to review it and to understand.