Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/bonsai-rx/setup-bonsai

Action for bootstrapping Bonsai environments from GitHub Actions workflows

https://github.com/bonsai-rx/setup-bonsai

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.0%) to scientific vocabulary

Keywords

actions bonsai-rx
Last synced: 6 months ago · JSON representation

Repository

Action for bootstrapping Bonsai environments from GitHub Actions workflows

Basic Info
  • Host: GitHub
  • Owner: bonsai-rx
  • License: mit
  • Language: TypeScript
  • Default Branch: main
  • Homepage:
  • Size: 1.48 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 1
  • Open Issues: 8
  • Releases: 1
Topics
actions bonsai-rx
Created 10 months ago · Last pushed 8 months ago
Metadata Files
Readme License

README.md

setup-bonsai

Action for bootstrapping Bonsai environments from GitHub Actions workflows.

To 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.

This action also handles injecting packages into Bonsai environments, which allows you to consume freshly built packages straight from the rest of your CI pipeline.

Usage

Basic usage is to simply invoke the action to install bootstrap the .bonsai environment at the root of your repository:

yml - name: Set up Bonsai environment uses: bonsai-rx/setup-bonsai@v1

Specifying the environment(s) to restore

You can specify the one or more Bonsai environments to restore using the environment-paths parameter:

yml - name: Set up Bonsai environments uses: bonsai-rx/setup-bonsai@v1 with: environment-paths: | .bonsai/ docs/examples/.bonsai/

Note that when possible it is preferred to pass multiple environments to a single setup-bonsai over invoking setup-bonsai multiple times. (See this issue for details.)

You can also use glob syntax to select multiple environments at once.

This example restores all environments across the entire repo:

yml - name: Set up Bonsai environments uses: bonsai-rx/setup-bonsai@v1 with: environment-paths: **/.bonsai/

Injecting packages

You can inject one or more .nupkg files into your Bonsai environment using the inject-packages parameter. Their dependencies will automatically be installed as well.

```yml - name: Download built packages uses: actions/download-artifact@v4 with: name: Packages path: artifacts/packages/

  • name: Set up Bonsai environment uses: bonsai-rx/setup-bonsai@v1 with: inject-packages: artifacts/packages/*.nupkg ```

Injected packages (and their dependencies not already present in Bonsai.config) are excluded from the package cache to avoid any cache poisoning issues.

(Specifically, the action captures the packages to be cached before the injected packages are even added to Bonsai.config.)

Documentation

See action.yml for a full list of input parameters and outputs supported by this action.

See the documentation folder for advanced documentation.

Owner

  • Name: Bonsai
  • Login: bonsai-rx
  • Kind: organization

A visual language for reactive programming

GitHub Events

Total
  • Release event: 3
  • Member event: 1
  • Push event: 2
  • Fork event: 1
  • Create event: 2
Last Year
  • Release event: 3
  • Member event: 1
  • Push event: 2
  • Fork event: 1
  • Create event: 2

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 4
  • Total Committers: 1
  • Avg Commits per committer: 4.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 4
  • Committers: 1
  • Avg Commits per committer: 4.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
David Maas d****t@n****g 4
Committer Domains (Top 20 + Academic)
neurogears.org: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 8
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.13
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 8
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.13
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

action.yml actions
  • dist/main.js node20 javascript
package-lock.json npm
  • 124 dependencies
package.json npm
  • @types/node ^22.15.17 development
  • esbuild 0.25.4 development
  • typescript ^5.8.3 development
  • @actions/cache ^4.0.3
  • @actions/core ^1.11.1
  • @actions/exec ^1.1.1
  • @actions/github ^6.0.1
  • @actions/glob ^0.5.0
  • @actions/io ^1.1.3