Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/broadinstitute/carrot-publish-github-action

A GitHub action for publishing a test to be run in CARROT via a PR comment

https://github.com/broadinstitute/carrot-publish-github-action

Science Score: 23.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
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.0%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

A GitHub action for publishing a test to be run in CARROT via a PR comment

Basic Info
  • Host: GitHub
  • Owner: broadinstitute
  • License: mit
  • Language: JavaScript
  • Default Branch: main
  • Size: 6.42 MB
Statistics
  • Stars: 0
  • Watchers: 5
  • Forks: 0
  • Open Issues: 5
  • Releases: 3
Created almost 6 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License

README.md

CARROT publish comment action

This action is meant to be used to publish a message to a Google Cloud PubSub topic to be picked up by a CARROT server and processed to run a test.

Running

Triggering the publish is done by posting a comment on a pull request in the form #carrot({test_name}, {test_input_key}, {eval_input_key}) where {testname} is the unique name of the test, {testinputkey} is the input in the test wdl to which the generated docker image should be supplied (can be left blank if {evalinputkey} is filled in), and {evalinputkey} is the input in the eval wdl to which the generated docker image should be supplied (can be left blank {testinput_key} is filled in).

A message is generated and sent to the PubSub topic to be forwarded to CARROT. CARROT will start a run of the specified test, beginning with generating a Docker image for the specific repo and commit relevant to the pull request comment that generated the message, provided the repo exists as a software entity within the CARROT database.

Usage

See action.yml

Example workflow: name: start-carrot-test-from-pr-comment on: issue_comment: types: [created] jobs: publish-test: runs-on: ubuntu-20.04 steps: - name: Parse comment uses: broadinstitute/carrot-publish-github-action@v0.3.0-beta with: software-name: carrot github-token: ${{ secrets.GITHUB_TOKEN }} topic-name: ${{ secrets.CARROT_TOPIC_NAME }} sa-key: ${{ secrets.CARROT_SA_KEY }} minimum-permissions: write

The value for software-name should match the name used in the software record in CARROT that you created to represent your repository.

CARROT_TOPIC_NAME should be defined as a secret in your repository as the name of the Google Cloud PubSub topic that run messages will be published to.

CARROT_SA_KEY should be defined as a secret in your repository as a service account key json for the Google Service Account that has access to publish to the topic specified by CARROT_TOPIC_NAME.

GITHUB_TOKEN will be generated automatically for communicating with the GitHub API, and does not need to be manually set.

Packaging

Runs from the dist/index.js entrypoint. The action must be packaged before a release so it can be used. npm run prepare git add dist

Owner

  • Name: Broad Institute
  • Login: broadinstitute
  • Kind: organization
  • Location: Cambridge, MA

Broad Institute of MIT and Harvard

GitHub Events

Total
  • Delete event: 1
  • Push event: 8
  • Pull request event: 1
  • Create event: 3
Last Year
  • Delete event: 1
  • Push event: 8
  • Pull request event: 1
  • Create event: 3

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 25
  • Total Committers: 1
  • Avg Commits per committer: 25.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 2
  • Committers: 1
  • Avg Commits per committer: 2.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Kevin Lydon k****n@b****g 25
Committer Domains (Top 20 + Academic)
broadinstitute.org: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 142
  • Average time to close issues: N/A
  • Average time to close pull requests: 26 days
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.93
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 139
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (127)
  • KevinCLydon (4)
Top Labels
Issue Labels
Pull Request Labels
dependencies (127)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total docker downloads: 14
  • Total dependent packages: 0
  • Total dependent repositories: 4
  • Total versions: 4
github actions: broadinstitute/carrot-publish-github-action

Action for triggering runs of tests defined in the Broad CARROT Application with PR Comments

  • License: mit
  • Status: removed
  • Latest release: 0.6.0
    published over 3 years ago
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 4
  • Docker Downloads: 14
Rankings
Dependent packages count: 0.0%
Dependent repos count: 16.5%
Average: 25.0%
Forks count: 35.1%
Stargazers count: 48.3%
Last synced: about 1 year ago

Dependencies

package-lock.json npm
  • 608 dependencies
package.json npm
  • @vercel/ncc ^0.24.0 development
  • eslint ^7.4.0 development
  • jest ^26.1.0 development
  • @actions/core ^1.2.5
  • @actions/github ^4.0.0
  • @google-cloud/pubsub ^2.5.0
.github/workflows/test.yml actions
  • actions/checkout v2 composite
action.yml actions
  • dist/index.js node12 javascript