Skip to content

Commit

Permalink
Update branding & README (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcampos authored Jul 25, 2024
1 parent d726808 commit 1621e30
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Rate My OpenAPI GitHub Action
# ramoa-action

<p align="center">
<a href="https://ratemyopenapi.com/">
Expand All @@ -7,14 +7,25 @@
</a>
</p>

ramoa-action analyzes an OpenAPI definition file using the Rate My OpenAPI API,
and reports the issues as console output, annotations and action summary.

The goal of ramoa-action is to help you establish best practices for your
OpenAPI's definitions across multiple categories that include security,
documentation and more.

This action provides the following functionality for GitHub Actions users:

- Run the Rate My OpenAPI rules on an OpenAPI spec file
- Get a summary of the the RMOA score in the action output
- Get annotations on the OpenAPI spec file per run
- Get a link to a detailed report

## Usage

Lint & get a score for your OpenAPI definition. You'll need to create a free api
key at the [Rate My Open API Portal](https://api.ratemyopenapi.com/docs).

See [action.yml](action.yml)

<!-- start usage -->
Expand Down
5 changes: 5 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@ name: 'ramoa-action'
description: 'GitHub Action to run RMOA lint rules on an OpenAPI spec'
author: 'Zuplo'

# branding
branding:
icon: check
color: white

# Define your inputs here.
inputs:
filepath:
Expand Down

0 comments on commit 1621e30

Please sign in to comment.