Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glitch-tools/glitch-deploy
CLI to deploy a GitHub repository to glitch.com
https://github.com/glitch-tools/glitch-deploy
Last synced: 2 days ago
JSON representation
CLI to deploy a GitHub repository to glitch.com
- Host: GitHub
- URL: https://github.com/glitch-tools/glitch-deploy
- Owner: glitch-tools
- License: apache-2.0
- Created: 2017-08-27T00:22:15.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-25T03:49:32.000Z (almost 2 years ago)
- Last Synced: 2024-10-07T20:18:01.785Z (about 1 month ago)
- Language: JavaScript
- Size: 8.36 MB
- Stars: 64
- Watchers: 4
- Forks: 6
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# glitch-deploy
> CLI tool to deploy a GitHub repository to glitch.com
## Usage
```
# requires node 8
npx glitch-deploy
```
Enable debug logs
```
DEBUG=glitch-deploy* npx glitch-deploy
```
Show browser UI
```
SHOW_BROWSER=1 npx glitch-deploy
```
## Deploy from CI
`glitch-deploy` can be run as part of your continious integration, for example
using [Travis CI](https://travis-ci.org/).
You have to set the following environment variables
- `GITHUB_USERNAME`
- `GITHUB_PASSWORD`
- `GITHUB_REPO` _(e.g. `octocat/Hello-World`)_
- `GLITCH_DOMAIN` _(the name of your Glitch app)_
It’s recommended to create a separate GitHub user account for the deployment to
keep your own account’s credentials safe. If the given Glitch app already exists
then make sure the account is invited as collaborator. If the repository is
private you have to invite the account as collaborator on GitHub, too.
Happy auto-deploying to Glitch :)
## How it works
`glitch-deploy` is using [puppeteer](https://github.com/GoogleChrome/puppeteer)
to run a headless Chrome browser to sign in to GitHub & Glitch, create a new
Glitch app and import the repository form GitHub.
Note that `glitch-deploy` is using undocumented Glitch APIs that might change at
any time.
## License
[Apache 2.0](LICENSE)