Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update branding & README #9

Merged
merged 1 commit into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading