https://github.com/opvious/api-server-action
GitHub action to set up an API server
https://github.com/opvious/api-server-action
Last synced: about 2 months ago
JSON representation
GitHub action to set up an API server
- Host: GitHub
- URL: https://github.com/opvious/api-server-action
- Owner: opvious
- License: apache-2.0
- Created: 2024-06-18T08:54:36.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-07T14:20:43.000Z (9 months ago)
- Last Synced: 2025-01-23T00:28:18.305Z (3 months ago)
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Set up API server action
```yaml
steps:
# ...
- uses: opvious/[email protected]
with:
license-key: ${{ secrets.OPVIOUS_LICENSE_KEY }} # Optional
```
## Inputs
All inputs are optional.
+ `license-key`: license key to unlock advanced API capabilities
+ `cli-version`: [CLI][] version, defaults to `latest`
+ `image-tag`: [server image][] tag, defaults to `latest`
+ `log-level`: log level, defaults to `info`
+ `skip-node-setup`: skip Node setup action, useful if already done
## Outputs
This action has no outputs. It sets the `OPVIOUS_ENDPOINT` and `OPVIOUS_TOKEN`
environment variables appropriately for later use by SDKs. The [`opvious`
CLI][CLI] is also installed for use in follow up steps.
## License
This action is licensed under Apache 2.0. The underlying [server image][] is
subject to the [Opvious API image EULA][EULA].
[server image]: https://hub.docker.com/r/opvious/api-server
[EULA]: https://www.opvious.io/end-user-license-agreements/api-image
[CLI]: https://www.npmjs.com/package/opvious-cli