# @snootclub/post-receive

> a post receive hook for deploying

Latest version **0.3.0** (published 2021-04-10) · GPL-3.0+ license · 0 weekly downloads

## Install

```sh
npm install @snootclub/post-receive
pnpm add @snootclub/post-receive
yarn add @snootclub/post-receive
bun add @snootclub/post-receive
```

Provides the command `post-receive`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2021-04-10 |
| First published | 2018-12-30 |
| Weekly downloads | 0 |
| License | GPL-3.0+ |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | chee |
| Maintainers | chee |
| Keywords | git, hook, post-receive, deploy |

## Links

- npm: https://www.npmjs.com/package/@snootclub/post-receive
- Repository: https://github.com/snootclub/post-receive
- Homepage: https://github.com/snootclub/post-receive#readme
- Issues: https://github.com/snootclub/post-receive/issues
- npm.io page: https://npm.io/package/@snootclub/post-receive

## Dependencies (4)

- [execa](https://npm.io/package/execa.md) ^1.0.0
- [yargs](https://npm.io/package/yargs.md) ^12.0.5
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.1
- [get-stream](https://npm.io/package/get-stream.md) ^4.1.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.3.0 (latest) — 2021-04-10
- 0.2.0 — 2021-04-10
- 0.1.0 — 2021-04-10
- 0.0.2 — 2018-12-31
- 0.0.1 — 2018-12-30
- 0.0.0 — 2018-12-30

## README

# snoot.club/post-receive

a post receive deploy hook for snoots

## usage

put `npx @snootclub/post-receive` in your serve-side repo's `hooks/post-receive`

## snoot usage

for default snoot behaviour you can do something like this inside your snoot container:

```sh
git init --bare /repo
>/repo/hooks/post-receive cat <<.
#!/bin/sh
npx @snootclub/post-receive
.
chmod +x /repo/hooks/post-receive
cd /application
git remote add origin /repo
git add .
git push
```

now you'll be able to do this on your local machine:

```sh
git clone ssh://snoot.club:$MY_PORT/repo snoot
```

and when you push up any changes in `snoot` it will install them,
build them and make them live.

## advanced usage

this isn't really specific to snoots and there are some options avaiable

### --deploymentDirectory

the directory to use as the deployment target, where files are served from
by the webserver.

default `/application`

### --deploymentBranch

the only brank acceptable to deploy from. if changes are pushed to any branch
other than this, they won't be deployed ^_^

default `master`

### --repoDirectory

the source bare repo directory used when deploying. by default this uses the
directory the process is running from, which will be the current repo when
used in a git hook :)

default `process.cwd()`

---
_Source: https://npm.io/package/@snootclub/post-receive · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._