build-this-branch

build-this-branch

Script to automate creating built branches.

_{Support this project by ⭐️ starring and sharing it. Follow me to see what other cool projects I'm working on! ❤️}

Usage

Run in your Git repository from the branch you want to build:

npx build-this-branch

⚠️ Warning: This command will force-push to the remote branch built/<current branch>. Please make sure there are no unsaved changes there. You can configure the built branch name with --built-branch <branch name>.

Flags

Flag	Description
-c, --build-command <command>	The command to build the branch. (default: npm run build)
-b, --built-branch <branch name>	The name of the built branch. Defaults to prefixing "built/" to the current branch.
-r, --remote <remote>	The remote to push to. (default: origin)
-d, --dry	Dry run mode
-h, --help	Show help
-v, --version	Show version

FAQ

What's a built branch?

In projects that build from source files, a built branch is a branch that contains built assets so it can be installed with npm:

npm install 'organization/repository#built-branch'

Built branches are useful for quickly testing changes and can be preferrable over permanently publishing a prerelease to npm.

What does this script do?

To make a built branch, this script does the following:

1. Run build script (eg. npm run build)
2. Create a new branch with the built/ namespace
3. Detects npm publish files and commits them to the new branch
4. Force pushes to remote
5. Deletes local built branch
6. Prints the installation command to install from the built branch