https://github.com/WaleedAshraf/asyncapi-github-action

GitHub action to validate if AsyncAPI schema file is valid or not.
https://github.com/WaleedAshraf/asyncapi-github-action

actions asyncapi asyncapi-specification github validation

Last synced: 3 months ago
JSON representation

GitHub action to validate if AsyncAPI schema file is valid or not.

• Host: GitHub
• URL: https://github.com/WaleedAshraf/asyncapi-github-action
• Owner: WaleedAshraf
• License: mit
• Created: 2020-03-19T20:29:59.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-09-08T05:57:37.000Z (over 1 year ago)
• Last Synced: 2024-05-02T05:20:21.814Z (9 months ago)
• Topics: actions, asyncapi, asyncapi-specification, github, validation
• Language: JavaScript
• Homepage: https://github.com/marketplace/actions/asyncapi-github-action
• Size: 1.1 MB
• Stars: 10
• Watchers: 3
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AsyncAPI Github Action

This action validates if the AsyncAPI schema file is valid or not.

## Inputs

### `filepath`

**Required** Path of the AsyncAPI schema file. Default is `"asyncapi.yaml"` at root. Path starts root of github repo.

For example, if you schema is in `schemas` folder.

```

root

├── schemas

│   └── asyncapi.yaml

├── index.js

└── package.json

```

You should use `filepath: './schemas/asyncapi.yaml'`

## Example usage

```

- name: asyncapi-github-action

  uses: WaleedAshraf/asyncapi-github-action@v0

  with:

    filepath: 'asyncapi.yaml'

```

You can specify version with `@v`. It follows semantic release. For latest release, please check [releases](https://github.com/WaleedAshraf/asyncapi-github-action/releases) page.

Here is screen shot of example usage:

![Example Usage](./assets/example.png "Example Usage")