{"id":14985943,"url":"https://github.com/surrealdb/setup-surreal","last_synced_at":"2025-04-11T22:12:27.024Z","repository":{"id":239835868,"uuid":"800379038","full_name":"surrealdb/setup-surreal","owner":"surrealdb","description":"GitHub Action for running SurrealDB in CI environments","archived":false,"fork":false,"pushed_at":"2024-12-13T08:52:36.000Z","size":18,"stargazers_count":14,"open_issues_count":2,"forks_count":2,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-04-11T22:12:19.760Z","etag":null,"topics":["action","actions","github-actions","surreal","surrealdb"],"latest_commit_sha":null,"homepage":"https://surrealdb.com","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/surrealdb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-14T08:12:33.000Z","updated_at":"2025-04-04T04:43:13.000Z","dependencies_parsed_at":"2024-05-15T18:05:02.399Z","dependency_job_id":"f355937e-8976-4521-82d3-5db8a8ab96f0","html_url":"https://github.com/surrealdb/setup-surreal","commit_stats":{"total_commits":7,"total_committers":2,"mean_commits":3.5,"dds":0.4285714285714286,"last_synced_commit":"09fb949fa060f900c5085d517de6eff0fc578847"},"previous_names":["surrealdb/setup-surreal"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surrealdb%2Fsetup-surreal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surrealdb%2Fsetup-surreal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surrealdb%2Fsetup-surreal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surrealdb%2Fsetup-surreal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/surrealdb","download_url":"https://codeload.github.com/surrealdb/setup-surreal/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248487683,"owners_count":21112190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["action","actions","github-actions","surreal","surrealdb"],"created_at":"2024-09-24T14:11:59.260Z","updated_at":"2025-04-11T22:12:27.001Z","avatar_url":"https://github.com/surrealdb.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# setup-surreal\n\nGithub CI integration for SurrealDB using Github Actions.\n\n## Arguments\n\nHere you see an overview of arguments you can use with setup-surreal action. In\nthe column `Default` you can see the default value of the argument. If you don't\nprovide a value for an argument, the default value will be used. But for those\narguments that don't have a default value are optional and are not used unless\nyou provide a value for them.\n\n| Argument                  | Description                        | Default | Value                                                                                |\n| ------------------------- | ---------------------------------- | ------- | ------------------------------------------------------------------------------------ |\n| surrealdb_version         | SurrealDB version to use           | latest  | `latest`, `v1.x.x`, `v2.x.x`                                                         |\n| surrealdb_port            | Port to run SurrealDB on           | 8000    | Valid number from `0` to `65535`                                                     |\n| surrealdb_username        | Username to use for SurrealDB      |         | Customisable by the user                                                             |\n| surrealdb_password        | Password to use for SurrealDB      |         | Customisable by the user                                                             |\n| surrealdb_auth            | Enable authentication              |         | `true`, `false`                                                                      |\n| surrealdb_strict          | Enable strict mode                 |         | `true`, `false`                                                                      |\n| surrealdb_log             | Enable logs                        |         | `none`, `full`, `warn`, `info`, `debug`, `trace`                                     |\n| surrealdb_additional_args | Additional arguments for SurrealDB |         | [Any valid SurrealDB CLI arguments](https://surrealdb.com/docs/surrealdb/cli/start#) |\n| surrealdb_retry_count     | Amount of availability retries | 30 | Any valid integer that represent `x` amount of seconds |\n\n## Usage\n\n```yaml\nname: SurrealDB CI\n\non: [push, pull_request]\n\njobs:\n  test:\n    runs-on: ubuntu-latest\n    steps:\n    - name: Git checkout\n      uses: actions/checkout@v2\n    - name: Start SurrealDB\n      uses: surrealdb/setup-surreal@v2\n      with:\n        surrealdb_version: latest\n        surrealdb_port: 8000\n        surrealdb_username: root\n        surrealdb_password: root\n        surrealdb_auth: false\n        surrealdb_strict: false\n        surrealdb_log: info\n        surrealdb_additional_args: --allow-all\n        surrealdb_retry_count: 30\n```\n\n## License\n\nThis GitHub Action is released under the\n[Apache License 2.0](https://github.com/surrealdb/license/blob/main/APL.txt).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurrealdb%2Fsetup-surreal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsurrealdb%2Fsetup-surreal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurrealdb%2Fsetup-surreal/lists"}