{"id":50505081,"url":"https://github.com/serverpod/serverpod_cloud_deploy","last_synced_at":"2026-06-02T15:02:20.411Z","repository":{"id":338809683,"uuid":"1159254104","full_name":"serverpod/serverpod_cloud_deploy","owner":"serverpod","description":"GitHub Action for Serverpod Cloud deployment automation.","archived":false,"fork":false,"pushed_at":"2026-02-17T12:12:21.000Z","size":301,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-16T23:51:38.464Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serverpod.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-16T14:05:46.000Z","updated_at":"2026-02-17T12:04:20.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/serverpod/serverpod_cloud_deploy","commit_stats":null,"previous_names":["serverpod/serverpod_cloud_deploy"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/serverpod/serverpod_cloud_deploy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverpod%2Fserverpod_cloud_deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverpod%2Fserverpod_cloud_deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverpod%2Fserverpod_cloud_deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverpod%2Fserverpod_cloud_deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serverpod","download_url":"https://codeload.github.com/serverpod/serverpod_cloud_deploy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverpod%2Fserverpod_cloud_deploy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33827068,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-02T02:00:07.132Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2026-06-02T15:02:19.171Z","updated_at":"2026-06-02T15:02:20.407Z","avatar_url":"https://github.com/serverpod.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Serverpod banner](https://github.com/serverpod/serverpod/raw/main/misc/images/github-header.webp)](https://github.com/serverpod/serverpod)\n\n# serverpod-cloud-deploy\n\n[serverpod-cloud-deploy][] deploys a project to [Serverpod Cloud](https://serverpod.dev/cloud).\n\n[serverpod-cloud-deploy]: https://github.com/marketplace/actions/serverpod-cloud-deploy\n\n\n## Usage\n\nThis is a simple workflow example that uses this action.\n\n```yml\nname: Automated Serverpod Cloud deploy\n\non:\n  push:\n    branches: [main]\n\npermissions:\n  contents: read\n\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n\n      - name: Setup Flutter SDK\n        uses: subosito/flutter-action@v2\n\n      - name: Activate serverpod command\n        run: dart pub global activate serverpod_cli\n\n      - uses: serverpod/serverpod-cloud-deploy@v1\n        with:\n          token: ${{ secrets.MY_SERVERPOD_CLOUD_ACCESS_TOKEN }}\n```\n\nPrerequisites:\n  * A GitHub secret has been set containing the access token\n    \u003e (create a token with `scloud auth create-token`)\n\n  * `serverpod generate` has been run and the generated files are committed\n\n  * `scloud.yaml` is committed in the server package\n    \u003e (create this file with `scloud launch` or `scloud link`)\n\n  * The repository has only one Serverpod project and it is no more than two\n    subdirectory levels down from the root\n\n\n## Inputs\n\nThe action takes the following inputs:\n\n- Required:\n\n  * `token`: Serverpod Cloud access token.\n\n- Optional:\n  * `working_directory`: Path to the action's working directory.\n    Default value is `.`\n\n  * `project_id`: Tenant project ID.\n\n  * `project_dir`: Path to the project's server directory.\n\n  * `project_config_file`: Path to the project's configuration file.\n\n\n## Combine with serverpod generate\n\nThe following workflow example does not requires the generated serverpod files\nto be committed nor the scloud.yaml file to be available.\n\n```yml\nname: Automated Serverpod Cloud generate \u0026 deploy\ndescription: \u003e\n  Checks out the repository, sets up Flutter, runs serverpod generate,\n  and deploys to Serverpod Cloud.\n\non:\n  push:\n    branches: [\"main\"]\n\npermissions:\n  contents: read\n\nenv:\n  # Change these values according to your project\n  PROJECT_ID: my-project-id\n  SERVER_DIR: ./packages/my_server\n  CLOUD_TOKEN: ${{ secrets.MY_SERVERPOD_CLOUD_ACCESS_TOKEN }}\n\njobs:\n  generate-and-deploy:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n\n      - name: Setup Flutter SDK\n        uses: subosito/flutter-action@v2\n\n      - name: Run serverpod generate\n        working-directory: ${{ env.SERVER_DIR }}\n        run: |\n          dart pub get\n          dart pub global activate serverpod_cli\n          serverpod generate\n\n      - uses: serverpod/serverpod_cloud_deploy@v1\n        with:\n          token: ${{ env.CLOUD_TOKEN }}\n          project_id: ${{ env.PROJECT_ID }}\n          project_dir: ${{ env.SERVER_DIR }}\n```\n\n\n## License\n\nSee the [LICENSE](LICENSE) file.\n\n## Contributing\n\nContributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## Version history\n\nPlease see our [CHANGELOG.md](CHANGELOG.md) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverpod%2Fserverpod_cloud_deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserverpod%2Fserverpod_cloud_deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverpod%2Fserverpod_cloud_deploy/lists"}