Git Product home page Git Product logo

release-action's Introduction

Publish Action

Yet another automatic release solution & changelog generator that is intended to work only with GitHub and have clean & configurable base, without unneeded layers of abstraction.

For now, I use it instead of semantic-release.This is some kind of rewritten version of semantic-release, more verbose config, better defaults and more deep integration with GitHub.

Highlights:

  • Works only with GitHub

  • uses GitHub API to fetch last tag and history of commits, instead of pulling full git history

  • Builtin presets for publishing to NPM and VSCode Marketplace

  • best possible TypeScript typing for the config

  • Better steps order:

    • get next version after analyzing commits
    • run build and test (even if no version bump)
    • if no version bump, exit
    • package and publish
    • new GitHub release and tag

But, the main difference is there is no real steps and plugins that define them. Presets do whatever they want in one step (package and publish).

Warning! Highly opinionated. bin entrypoint is intended to be run on main branch of GitHub action environment.

Special Flags

  • [go-stable] Bumps version to v1.0.0. Useful on unstableSemver strategy (default). If version is already 1.0.0 or higher, does nothing. TODO: allow without message
  • [publish] (Only if enabled in config). Publish only from latest tag to commit that starts with this flag.

But its not possible to combine them or with them. e.g. this would fail: WIP [publish]

Why not semantic-release

  • seamless integration with existing packages e.g. would fetch latest version from npm instead of starting with v1.0.0 of no tags found
  • starts v0.0.1 instead of making your package stable by default and remains to hold your package unstable (bumps minor only on BREAKING), until you mark as stable by special flag (see above)
  • runs test / linter / build for you only test and build scripts must be present. Linter script would be opinionated

TODO

  • prerelease
  • contribution channels

release-action's People

Contributors

ilanaya avatar zardoy avatar

Watchers

 avatar

Forkers

ilanaya

release-action's Issues

review config

this is pretty obvious for me, but recording here to not forget

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.