{"id":28296756,"url":"https://github.com/bonsai-rx/setup-bonsai","last_synced_at":"2026-05-07T07:40:20.512Z","repository":{"id":292252490,"uuid":"980295642","full_name":"bonsai-rx/setup-bonsai","owner":"bonsai-rx","description":"Action for bootstrapping Bonsai environments from GitHub Actions workflows ","archived":false,"fork":false,"pushed_at":"2025-05-14T06:48:31.000Z","size":1545,"stargazers_count":0,"open_issues_count":8,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-09T13:17:35.114Z","etag":null,"topics":["actions","bonsai-rx"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bonsai-rx.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,"zenodo":null}},"created_at":"2025-05-08T22:36:09.000Z","updated_at":"2025-05-14T07:03:00.000Z","dependencies_parsed_at":"2025-05-14T07:47:37.859Z","dependency_job_id":null,"html_url":"https://github.com/bonsai-rx/setup-bonsai","commit_stats":null,"previous_names":["ngrdavid/setup-bonsai","bonsai-rx/setup-bonsai"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/bonsai-rx/setup-bonsai","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bonsai-rx%2Fsetup-bonsai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bonsai-rx%2Fsetup-bonsai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bonsai-rx%2Fsetup-bonsai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bonsai-rx%2Fsetup-bonsai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bonsai-rx","download_url":"https://codeload.github.com/bonsai-rx/setup-bonsai/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bonsai-rx%2Fsetup-bonsai/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259808101,"owners_count":22914570,"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":["actions","bonsai-rx"],"created_at":"2025-05-22T21:20:02.548Z","updated_at":"2026-05-07T07:40:20.469Z","avatar_url":"https://github.com/bonsai-rx.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# setup-bonsai\r\n\r\nAction for bootstrapping [Bonsai environments](https://bonsai-rx.org/docs/articles/environments) from GitHub Actions workflows.\r\n\r\nTo help speed up your CI, this action will (by default) automatically cache the Bonsai packages used to restore your environments using the [GitHub Actions cache](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/caching-dependencies-to-speed-up-workflows).\r\n\r\nThis action also handles injecting packages into Bonsai environments, which allows you to consume freshly built packages straight from the rest of your CI pipeline.\r\n\r\n## Usage\r\n\r\nBasic usage is to simply invoke the action to install bootstrap the `.bonsai` environment at the root of your repository:\r\n\r\n```yml\r\n- name: Set up Bonsai environment\r\n  uses: bonsai-rx/setup-bonsai@v1\r\n```\r\n\r\n### Specifying the environment(s) to restore\r\n\r\nYou can specify the one or more Bonsai environments to restore using the `environment-paths` parameter:\r\n\r\n```yml\r\n- name: Set up Bonsai environments\r\n  uses: bonsai-rx/setup-bonsai@v1\r\n  with:\r\n    environment-paths: |\r\n      .bonsai/\r\n      docs/examples/.bonsai/\r\n```\r\n\r\nNote that when possible it is preferred to pass multiple environments to a single `setup-bonsai` over invoking `setup-bonsai` multiple times. (See [this issue](https://github.com/bonsai-rx/setup-bonsai/issues/4) for details.)\r\n\r\nYou can also use [glob syntax](https://github.com/actions/toolkit/tree/36db4d62adf0bf89f2ebae569f59279e55bcd67f/packages/glob#patterns) to select multiple environments at once.\r\n\r\nThis example restores all environments across the entire repo:\r\n\r\n```yml\r\n- name: Set up Bonsai environments\r\n  uses: bonsai-rx/setup-bonsai@v1\r\n  with:\r\n    environment-paths: **/.bonsai/\r\n```\r\n\r\n### Injecting packages\r\n\r\nYou can inject one or more `.nupkg` files into your Bonsai environment using the `inject-packages` parameter. Their dependencies will automatically be installed as well.\r\n\r\n```yml\r\n- name: Download built packages\r\n  uses: actions/download-artifact@v4\r\n  with:\r\n    name: Packages\r\n    path: artifacts/packages/\r\n\r\n- name: Set up Bonsai environment\r\n  uses: bonsai-rx/setup-bonsai@v1\r\n  with:\r\n    inject-packages: artifacts/packages/*.nupkg\r\n```\r\n\r\nInjected packages (and their dependencies not already present in `Bonsai.config`) are excluded from the package cache to avoid any cache poisoning issues.\r\n\r\n(Specifically, the action captures the packages to be cached before the injected packages are even added to `Bonsai.config`.)\r\n\r\n## Documentation\r\n\r\nSee [action.yml](action.yml) for a full list of input parameters and outputs supported by this action.\r\n\r\nSee [the documentation folder](docs/) for advanced documentation.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbonsai-rx%2Fsetup-bonsai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbonsai-rx%2Fsetup-bonsai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbonsai-rx%2Fsetup-bonsai/lists"}