Skip to content

Commit

Permalink
Rename to rmoa-action
Browse files Browse the repository at this point in the history
  • Loading branch information
lcampos committed Jul 26, 2024
1 parent 36d0072 commit 49ba9af
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Rate My OpenAPI Action
# rmoa-action

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

ramoa-action analyzes an OpenAPI definition file using the Rate My OpenAPI API,
rmoa-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
The goal of rmoa-action is to help you establish best practices for your
OpenAPI's definitions across multiple categories that include security,
documentation and more.

Expand All @@ -31,7 +31,7 @@ See [action.yml](action.yml)
<!-- start usage -->

```yaml
- uses: zuplo/ramoa-action@v1
- uses: zuplo/rmoa-action@v1
with:
# File containing the OpenAPI Spec to be linted. Examples: my-api.oas.json, api-spec.yaml
filepath: ''
Expand All @@ -56,7 +56,7 @@ See [action.yml](action.yml)
```yaml
steps:
- uses: actions/checkout@v4
- uses: zuplo/ramoa-action@v1
- uses: zuplo/rmoa-action@v1
with:
filepath: './my-api.json'
apikey: ${{ secrets.RMOA_API_KEY }}
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 'ramoa-action'
name: 'Rate My OpenAPI Action'
description: 'GitHub Action to run RMOA lint rules on an OpenAPI spec'
author: 'Zuplo'

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "ramoa-action",
"name": "rmoa-action",
"description": "GitHub Action to run RMOA lint rules on an OpenAPI spec",
"version": "0.0.0",
"author": "Zuplo",
Expand Down

0 comments on commit 49ba9af

Please sign in to comment.