ActionsToolbox/gem-build-and-release-action

Build and publish a Ruby Gem to rubygems.org

https://github.com/actionstoolbox/gem-build-and-release-action

Science Score: 44.0%

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

  • CITATION.cff file
    Found 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 (9.0%) to scientific vocabulary

Keywords

cicd github-action github-actions rubygems wolfsoftware

Keywords from Contributors

pypi mesh interpretability sequences projection interactive optim hacking network-simulation
Last synced: 4 months ago · JSON representation ·

Repository

Build and publish a Ruby Gem to rubygems.org

Basic Info
  • Host: GitHub
  • Owner: ActionsToolbox
  • License: mit
  • Language: Shell
  • Default Branch: master
  • Homepage:
  • Size: 185 KB
Statistics
  • Stars: 2
  • Watchers: 0
  • Forks: 0
  • Open Issues: 3
  • Releases: 5
Topics
cicd github-action github-actions rubygems wolfsoftware
Created over 3 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Codeowners Security

README.md

ActionsToolbox logo
Github Build Status License Created
Release Released Commits since release

Overview

This action works by executing the following commands:

  • bundle install
  • gem build --output=latest-release.gem
  • gem push latest-release.gem > Assuming PUBLISH is set to true which is the default.

We create and publish the gems this way for a few very specific reasons:

  • We want to minimise the permissions that need to be given to the action.
  • We do not want the action to make any changes to the existing repository.
  • We want the action to only execute the minimum steps required to build and publish a gem.

There are many other gems available that work with rake release if this is your preferred method. The 2 that we recommend are below:

Publish

```yaml name: Publish Gem

on: push: tags: - 'v[0-9].[0-9]+.[0-9]+' - '!v[0-9].[0-9]+.[0-9]+rc[0-9]+'

jobs: build: runs-on: ubuntu-latest

steps:
  - uses: actions/checkout@v4

  - name: Release Gem
    uses: ActionsToolbox/gem-build-and-release-action@master
    env:
      RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

```

Build but Don't Publish

```yaml name: Test Publish Gem

on: push: tags: - 'v[0-9].[0-9]+.[0-9]+rc[0-9]+'

jobs: build: runs-on: ubuntu-latest

steps:
  - uses: actions/checkout@v4

  - name: Release Gem
    uses: ActionsToolbox/gem-build-and-release-action@master
    env:
      RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
      PUBLISH: false

```


Owner

  • Name: Actions Toolbox
  • Login: ActionsToolbox
  • Kind: organization
  • Email: github@wolfsoftware.com
  • Location: United Kingdom

A collection of GitHub actions. Created by Wolf Software.

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: Gem Build and Release
abstract: Build and publish a Ruby Gem to RubyGems.org.
type: software
version: 0.1.0
date-released: 2024-06-05
repository-code: https://github.com/ActionsToolbox/gem-build-and-release-action
keywords:
  - "Wolf Software"
  - "Software"
license: MIT
authors:
  - family-names: "Wolf"
    orcid: "https://orcid.org/0009-0007-0983-2072"

GitHub Events

Total
  • Delete event: 65
  • Issue comment event: 132
  • Push event: 117
  • Pull request review event: 108
  • Pull request event: 129
  • Create event: 68
Last Year
  • Delete event: 65
  • Issue comment event: 132
  • Push event: 117
  • Pull request review event: 108
  • Pull request event: 129
  • Create event: 68

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 15
  • Total Committers: 3
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.533
Top Committers
Name Email Commits
github-actions[bot] c****t@w****m 7
dependabot[bot] 4****] 5
Tim Gurney aka Wolf w****f@t****m 3
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 0
  • Total pull requests: 63
  • Average time to close issues: N/A
  • Average time to close pull requests: 13 days
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.52
  • Merged pull requests: 51
  • Bot issues: 0
  • Bot pull requests: 63
Past Year
  • Issues: 0
  • Pull requests: 48
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.71
  • Merged pull requests: 38
  • Bot issues: 0
  • Bot pull requests: 48
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (105)
Top Labels
Issue Labels
Pull Request Labels
dependabot: dependencies (105) dependabot: ecosystem : github actions (105) dependabot: auto approve (79) dependabot: auto merge (79) dependabot: manual merge (4) dependabot: manual QA (3) resolution: closed (2) state: stale (2)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 5
github actions: ActionsToolbox/gem-build-and-release-action

A tool for releasing ruby gems to RubyGems.org.

  • License: mit
  • Latest release: v0.1.1
    published over 1 year ago
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 1
Rankings
Dependent packages count: 0.0%
Average: 21.8%
Dependent repos count: 24.8%
Stargazers count: 27.4%
Forks count: 35.2%
Last synced: 4 months ago

Dependencies

.github/workflows/greetings.yml actions
  • actions/first-interaction v1 composite
action.yml actions
  • Dockerfile * docker
Dockerfile docker
  • wolfsoftwareltd/gem-release 0.0.1 build
.github/workflows/cicd.yml actions
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
.github/workflows/citation-validation.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • citation-file-format/cffconvert-github-action 4cf11baa70a673bfdf9dad0acc7ee33b3f4b6084 composite
  • ruby/setup-ruby d5fb7a202fc07872cb44f00ba8e6197b70cb0c55 composite
.github/workflows/delete-old-workflow-runs.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • Mattraks/delete-workflow-runs 39f0bbed25d76b34de5594dceab824811479e5de composite
.github/workflows/dependabot.yml actions
  • dependabot/fetch-metadata 5e5f99653a5b510e8555840e80cbf1514ad4af38 composite
.github/workflows/document-validation.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • actions/setup-node 60edb5dd545a775178f52524783378180af0d1f8 composite
  • ruby/setup-ruby d5fb7a202fc07872cb44f00ba8e6197b70cb0c55 composite
.github/workflows/generate-release.yml actions
  • Bullrich/generate-release-changelog 6b60f004b4bf12ff271603dc32dbd261965ad2f2 composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • softprops/action-gh-release 69320dbe05506a9a39fc8ae11030b214ec2d1f87 composite
.github/workflows/generate-test-release.yml actions
  • Bullrich/generate-release-changelog 6b60f004b4bf12ff271603dc32dbd261965ad2f2 composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • softprops/action-gh-release 69320dbe05506a9a39fc8ae11030b214ec2d1f87 composite
.github/workflows/greetings.yml.old actions
  • actions/first-interaction v1 composite
.github/workflows/purge-deprecated-workflow-runs.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • otto-de/purge-deprecated-workflow-runs 31a4e821d43e9a354cbd65845922c76e4b4b3633 composite
.github/workflows/repository-validation.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • actions/setup-go cdcb36043654635271a94b9a6d1392de5bb323a7 composite
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
.github/workflows/security-hardening.yml actions
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • zgosalvez/github-actions-ensure-sha-pinned-actions 2f2ebc6d914ab515939dc13f570f91baeb2c194c composite
.github/workflows/stale.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • actions/stale 28ca1036281a5e5922ead5184a1bbf96e5fc984e composite