Skip to content

juancarlosjr97/release-it-containerized

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Release It - Containerized

test Codacy Badge GitHub Release MIT

A containerized version of release-it that runs in any environment without requiring a Node.js installation. This project is a wrapper providing the environment and setup to execute release-it directly from a container.

Note

This project is released using release-it and this containerized version, including pre-releases.

How It Works

At runtime the container:

  1. Configures Git (user, email, remote URL, safe directory)
  2. Imports GPG key and enables signed commits (if provided)
  3. Configures SSH key and starts the SSH agent (if provided)
  4. Installs the requested NPM and release-it version (defaults to latest)
  5. Installs any additional release-it plugins from RELEASE_IT_PLUGINS
  6. Executes release-it with the arguments passed to the container

The project must include a valid release-it configuration file.

Quick Start

Docker

docker run \
    -e GITHUB_TOKEN="<token>" \
    -e GIT_EMAIL="you@example.com" \
    -e GIT_USERNAME="Your Name" \
    -v $(pwd):/app \
    ghcr.io/juancarlosjr97/release-it-containerized \
    release-it --ci

GitHub Action

- name: Release
  uses: juancarlosjr97/release-it-containerized@1.0.12
  with:
    github_token: ${{ secrets.RELEASE_IT_GITHUB_TOKEN }}

Important

A Personal Access Token (PAT) with contents: write must be stored as a repository secret and passed as github_token. The default ${{ github.token }} is not supported.

Documentation

  • Usage β€” full input reference, Docker examples, and GitHub Action setup

Acknowledgment

This project is only possible due to the existence of release-it and all its contributors for the great work.

Contributing

We welcome contributions! Please see our Contributing Guide for details on:

  • How to report bugs
  • How to suggest enhancements
  • Development workflow
  • Commit message conventions
  • Pull request process

License

This project is licensed under the MIT License. See the LICENSE file.

Support Information

About

πŸš€ A Containerized release-it to run anywhere

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors