https://github.com/tableflip/tars
:shipit: TABLEFLIP Automated Release System
https://github.com/tableflip/tars
Last synced: about 1 year ago
JSON representation
:shipit: TABLEFLIP Automated Release System
- Host: GitHub
- URL: https://github.com/tableflip/tars
- Owner: tableflip
- Created: 2016-03-15T09:51:04.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-11-08T16:27:49.000Z (over 8 years ago)
- Last Synced: 2025-02-15T12:46:45.043Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TARS
TABLEFLIP Automated Release System.
## Getting started
1. Install Node.js
2. Install dependencies `npm install`
3. (Optional) Add builder config file `.tarsrc` (defaults below):
```js
{
webhook: {
path: '/webhook',
secret: '(╯°□°）╯︵TABLEFLIP',
port: 7777
},
release: {
dir: './release',
branch: 'gh-pages', // Restrict releases to tags on the specified branch
}
}
```
4. Start the webhook `npm start`
## Configure a site to be released
1. Navigate to **Settings** for the repo
2. In **Collaborators**, add `tableflip-tars` as a collaborator with **read** access
3. in **Webhooks & services** add a new webhook with the following info:
* Payload URL: `http://tars.tableflip.io:7777/webhook`
* Content type: `application/json`
* Secret: **Retrieve from secrets.yaml for tars-infrastructure project**
* Event: **Create** (Branch or tag created)
## Programmatic usage
**release.js**
```js
const release = require('./release')
const repo = 'git@github.com:tableflip/tableflip-www.git'
const tag = 'v1.0.1'
const opts = {stdout: process.stdout, stderr: process.stderr}
release(repo, tag, opts, (err, info) => {
console.log(`Released in ${info.dir}`)
})
```