https://github.com/devonchurch/sauerkraut
An AWS CodeBuild sequence to simultaneously create package install hooks in NPM, GitHub and AWS S3
https://github.com/devonchurch/sauerkraut
aws-codebuild aws-s3 aws-sdk github npm
Last synced: 2 months ago
JSON representation
An AWS CodeBuild sequence to simultaneously create package install hooks in NPM, GitHub and AWS S3
- Host: GitHub
- URL: https://github.com/devonchurch/sauerkraut
- Owner: devonChurch
- Created: 2018-10-04T07:24:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-13T09:13:59.000Z (over 7 years ago)
- Last Synced: 2025-03-17T22:07:27.061Z (over 1 year ago)
- Topics: aws-codebuild, aws-s3, aws-sdk, github, npm
- Language: JavaScript
- Homepage:
- Size: 594 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sauerkraut 🍲
[](https://badge.fury.io/js/%40devon-church%2Fsauerkraut) 
An [AWS CodeBuild](https://aws.amazon.com/codebuild/) sequence to simultaneously create package _install_ hooks in [NPM](https://www.npmjs.com/), [GitHub](https://github.com/) and [AWS S3](https://aws.amazon.com/s3/).
## Pipeline ⚙️
## Usage 🎛️
### S3
Holds `.tgz` files associated to each released version of that package.
#### Usage
Install version `1.0.8` of the package.
```
npm install "https://s3.amazonaws.com/sauerkraut/1.0.8.tgz"
```
#### Versioning
Package versions are targeted via their associated **file names** e.g `1.0.8.tgz`
### Github
Holds the necessary [_raw_ assets](https://docs.npmjs.com/getting-started/packages#what-is-a-package-) required for NPM to verify the package.
- `package.json`
- `package.js` _(The CLI Hook)_
- `dist/*` _(The package content)_
#### Usage
Install version `1.0.8` of the package.
```
npm install "git://github.com/devonChurch/sauerkraut.git#v1.0.8"
```
#### Versioning
Package versions are targeted via their associated **tag names** e.g `#v1.0.8`
### NPM
Uses the traditional [NPM installation process](https://docs.npmjs.com/getting-started/installing-npm-packages-locally) with this package residing under the `@devon-church` scope.
#### Usage
Install version `1.0.8` of the package.
```
npm install @devon-church/sauerkraut@1.0.8
```
### Versioning
Package versions can be targeted via NPM's [version selector syntax](https://docs.npmjs.com/cli/install#synopsis) e.g `@1.0.8`
## Note 💡
Unlike **NPM**, the package assets stored on **GitHub** and **AWS S3** are statically referenced. This means that you can not request a [dynamic server range](https://semver.npmjs.com/) as there is no registry implementing version reconciliation.