Code Monkey home page Code Monkey logo

generate-release's Introduction

๐Ÿ› ๏ธ Automatic Release Creation beta

Latest release version

This Action is in the beta right now

Automatically create release tags based on files updated in a commit for JavaScript/TypeScript projects. If you are new into GitHub Actions read this quick start guide first

Usage

Add following entry into your jobs list

<job-name>:
  runs-on: ubuntu-latest
  permissions:
    contents: write
  steps:
    - name: Automatic Release Creation
      uses: lr0pb/[email protected]
      with:
        token: ${{ secrets.GITHUB_TOKEN }}

Action inputs and outputs

Inputs

Inputs are like arguments for functions and must be set by the with keyword in your <step-name> that uses this Action

Name Description Required? Default value
token Your GITHUB_TOKEN to provide access to GitHub REST API โ— Yes
track-file Path to file used to track updates:
package.json file in whatever directory
โœ… No package.json
notes-source Source type for release notes:
changelog | auto
โœ… No changelog
notes-file Path to changelog file used to provide release descriptions โœ… No CHANGELOG.md
notes-fallback Fallback for release notes when no changelog file founded or when no description in this file for the new version:
fallbackText | auto
โœ… No fallbackText
fallback-text input value
fallback-text Text used for fallbackText release notes fallback โœ… No "No description ๐Ÿ’ญ"
tag-pattern Custom tag pattern for release title โœ… No v{major}.{minor}.{patch}

Ready-to-use workflow file

Full workflow file template for your automatic release creation process:

name: Create release

on:
  push:
    branches: ['main']

jobs:
  release:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Automatic Release Creation
        uses: lr0pb/[email protected]
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

generate-release's People

Contributors

lr0pb avatar

Watchers

 avatar

generate-release's Issues

Update major release tag in Actions repos

Custom GitHub Actions lived in dedicated repositories (like this one) often have something like "v1" tag for major version. This tag should point to the latest stable version (i.e. if latest is v1.2.5, using action@v1 should use 1.2.5 code).
So, generate-release can make it automatically when detects action.y(a?)ml file in the root of repo.
update-major-tag input that set by default in true can be used to opt out this behaviour.

`notes-fallback` input

Currently in cases when no description detected in CHANGELOG file, action provides No description ๐Ÿ’ญ text to release notes body.

notes-fallback will rule to what use for notes in this case: empty | auto

Where empty is current behavior and auto is auto-generation release notes by GitHub, same as notes-source: auto

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.