Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/surrealdb/setup-surreal
GitHub Action for running SurrealDB in CI environments
https://github.com/surrealdb/setup-surreal
action actions github-actions surreal surrealdb
Last synced: 3 months ago
JSON representation
GitHub Action for running SurrealDB in CI environments
- Host: GitHub
- URL: https://github.com/surrealdb/setup-surreal
- Owner: surrealdb
- License: apache-2.0
- Created: 2024-05-14T08:12:33.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-08-14T08:03:55.000Z (5 months ago)
- Last Synced: 2024-09-30T23:25:01.823Z (3 months ago)
- Topics: action, actions, github-actions, surreal, surrealdb
- Language: Shell
- Homepage: https://surrealdb.com
- Size: 12.7 KB
- Stars: 9
- Watchers: 9
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# setup-surreal
Github CI integration for SurrealDB using Github Actions.
## Arguments
Here you see an overview of arguments you can use with setup-surreal action. In
the column `Default` you can see the default value of the argument. If you don't
provide a value for an argument, the default value will be used. But for those
arguments that don't have a default value are optional and are not used unless
you provide a value for them.
| Argument | Description | Default | Value |
| ------------------------- | ---------------------------------- | ------- | ------------------------------------------------------------------------------------ |
| surrealdb_version | SurrealDB version to use | latest | `latest`, `v1.x.x` |
| surrealdb_port | Port to run SurrealDB on | 8000 | Valid number from `0` to `65535` |
| surrealdb_username | Username to use for SurrealDB | | Customisable by the user |
| surrealdb_password | Password to use for SurrealDB | | Customisable by the user |
| surrealdb_auth | Enable authentication | | `true`, `false` |
| surrealdb_strict | Enable strict mode | | `true`, `false` |
| surrealdb_log | Enable logs | | `none`, `full`, `warn`, `info`, `debug`, `trace` |
| surrealdb_additional_args | Additional arguments for SurrealDB | | [Any valid SurrealDB CLI arguments](https://surrealdb.com/docs/surrealdb/cli/start#) |
## Usage
```yaml
name: SurrealDB CI
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
steps:
- name: Git checkout
uses: actions/checkout@v2
- name: Start SurrealDB
uses: surrealdb/setup-surreal@v1
with:
surrealdb_version: latest
surrealdb_port: 8000
surrealdb_username: root
surrealdb_password: root
surrealdb_auth: false
surrealdb_strict: false
surrealdb_log: info
surrealdb_additional_args: --allow-all
```
## License
This GitHub Action is released under the
[Apache License 2.0](https://github.com/surrealdb/license/blob/main/APL.txt).