Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrloop/netlify-git-branch
Feature branch staging environments with netlify and git
https://github.com/mrloop/netlify-git-branch
continuous-deployment git javascript netlify
Last synced: about 1 month ago
JSON representation
Feature branch staging environments with netlify and git
- Host: GitHub
- URL: https://github.com/mrloop/netlify-git-branch
- Owner: mrloop
- License: mit
- Created: 2021-11-09T20:10:58.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T15:23:20.000Z (2 months ago)
- Last Synced: 2024-10-24T21:11:20.332Z (about 2 months ago)
- Topics: continuous-deployment, git, javascript, netlify
- Language: TypeScript
- Homepage:
- Size: 1.05 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
netlify-git-branch
==================
[](https://github.com/mrloop/netlify-git-branch/actions/workflows/ci.yml)
[![Latest NPM release][npm-badge]][npm-badge-url]
[npm-badge]: https://img.shields.io/npm/v/netlify-git-branch.svg
[npm-badge-url]: https://www.npmjs.com/package/netlify-git-branch
Feature branch staging environments with netlify and git.
Easily deploy feature branches to indiviudal subdomains on netlify.
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g netlify-git-branch
$ netlify-git-branch COMMAND
running command...
$ netlify-git-branch (--version)
netlify-git-branch/2.0.0 linux-x64 node-v16.13.0
$ netlify-git-branch --help [COMMAND]
USAGE
$ netlify-git-branch COMMAND
...
```
# Commands
* [`netlify-git-branch delete NAME`](#netlify-git-branch-delete-name)
* [`netlify-git-branch deploy NAME`](#netlify-git-branch-deploy-name)
* [`netlify-git-branch help [COMMAND]`](#netlify-git-branch-help-command)
## `netlify-git-branch delete NAME`
Delete netlify staging subdomain for this branch
```
USAGE
$ netlify-git-branch delete [NAME]
ARGUMENTS
NAME Name is prefixed onto the git branch name. For Example on branch 'my-feature' and a name of 'my-site' the domain
will be 'https://my-site-my-feature.netlify.app'.
DESCRIPTION
Delete netlify staging subdomain for this branch
EXAMPLES
$ netlify-git-branch delete my-site
```
_See code: [src/commands/delete/index.ts](https://github.com/mrloop/netlify-git-branch/blob/v2.0.0/src/commands/delete/index.ts)_
## `netlify-git-branch deploy NAME`
Deploy branch to netlify staging subdomain
```
USAGE
$ netlify-git-branch deploy [NAME] [--dir ] [--assert ]
ARGUMENTS
NAME Name is prefixed onto the git branch name. For Example on branch 'my-feature' and a name of 'my-site' the domain
will be 'https://my-site-my-feature.netlify.app'.
FLAGS
--assert= Check deployed site using CSS
--dir= [default: dist] Deploy site from
DESCRIPTION
Deploy branch to netlify staging subdomain
EXAMPLES
$ netlify-git-branch deploy my-site --dir dist
```
_See code: [src/commands/deploy/index.ts](https://github.com/mrloop/netlify-git-branch/blob/v2.0.0/src/commands/deploy/index.ts)_
## `netlify-git-branch help [COMMAND]`
display help for netlify-git-branch
```
USAGE
$ netlify-git-branch help [COMMAND] [--json] [--all]
ARGUMENTS
COMMAND command to show help for
FLAGS
--all see all commands in CLI
--json Format output as json.
DESCRIPTION
display help for netlify-git-branch
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v4.0.3/src/commands/help.ts)_