https://github.com/ttab/artie
architecture-components maybe public
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ttab/artie
- Owner: ttab
- Created: 2015-11-19T10:41:00.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-01-03T14:46:59.000Z (over 9 years ago)
- Last Synced: 2025-02-26T15:42:32.606Z (over 1 year ago)
- Topics: architecture-components, maybe, public
- Language: CoffeeScript
- Homepage:
- Size: 58.6 KB
- Stars: 0
- Watchers: 15
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# artie
Node.js release management.
* Creates release packages from node.js projects. The packages
are self-contained executables.
* Uploads packages as attached files to GitHub releases.
* Downloads the latest package from GitHub and sets up permissions
and symlinks.
## Usage
### `artie upload [-o ] [-a ] [-n ] [-t ]`
Packages the node.js project in the current directory as an executable
archive using [nar]. The archive layout can be
[configured in package.json][narcfg].
If the current commit also has a tag, the package is uploaded and
attached to the GitHub release with the same tag.
If we are *not* on a tag, we assume that this package is for
development purposes, and a new GitHub draft release is created using
the abbreviated commit object as the name.
### `artie download [-o ] [-a ] [-p] [-t ]`
Queries GitHub for the latest package matching the supplied `os` and
`arch`, and downloads the package (if it doesn't already exist) to the
current directory. Creates a symlink with the same name as ``
pointing to the newly downloaded file.
If `-p` is specified, we will only download fully tagged production
releases. Otherwise, we will also consider draft releases.
Releases marked as `pre-release` will never be downloaded.
## Node.js version
The version of the embedded node.js executable is determined as follows:
1. If the `-n` options is specified, we will use that.
2. If `.nvmrc` exists in the project root, we will look for a node.js
version there.
3. Otherwise, fall back to the system default.
## Authentication
`artie` needs a personal access token to be able to work with
GitHub. It can be supplied either with the `-t ` option or by
setting the `GITHUB_OAUTH_TOKEN` environment variable.
[nar]:https://github.com/h2non/nar
[narcfg]:https://github.com/h2non/nar#configuration
## Slack notifications
```
export SLACK_WEBHOOK=https://hooks.slack.com/services/ASD28TH/B0asdCQ/6876786sd8f6asdasdgxcv
export SLACK_CHANNEL=general
```