README.md

Atomic Release

Atomic Release is an SDK to help automate a software release process with the ability to "undo" steps taken when a release process fails.

Highlights

• TypeScript friendly.

• A super simple SDK with loosely coupled APIs. Use just what you need.

• Can be used with any project type (just need a node runtime).

• A strategy for releasing npm packages: (bumping versions, generating changelogs, and much more)

  

  A failure during a release undoes previous commands

Find out more by reading the docs

💡   Fun fact: This library is released using githubNpmPackageStrategy. See example

Install

Prerequisites: Node.js

npm install --save-dev @abstracter/atomic-release

Documentation

• Logger
  • processStdoutLogger
• Strategy
  • githubNpmPackageStrategy
• Release
  • gitTrunkRelease
  • gitTagBasedRelease
• GitClient
  • GitExecClient
• Command
  • ExecCommand
  • HttpCommand
  • FileWriterCommand
  • GitCommitCommand
  • GitSwitchBranchCommand
  • GitPushBranchCommand
  • GitTagCommand
  • GithubHttpCommand
  • GithubCreateIssueCommentsCommand
  • GithubCreatePullRequestCommand
  • GithubCreateReleaseCommand
  • NpmCommand
  • NpmBumpPackageVersionCommand
  • NpmPublishPackageCommand

FAQ

• Where is package-lock.json?
  Read this blog post by Twilio learn more.

• Do I have to use TypeScript to use this SDK?
  No you don't.