/sync-glitch-cli

:flags: Sync changes in your GitHub repository to glitch.com

Primary LanguageJavaScriptApache License 2.0Apache-2.0


sync-glitch-cli npm build status codecov Dependabot Status

Sync changes in your GitHub repository to glitch.com

It pushes changes from a GitHub repository to glitch.com. It does NOT pull changes from glitch.com to GitHub.

Heads-up! It uses undocumented API so it can be changed without any notice. However, I am making efforts to know whether it works or not with test-sync-glitch-cli. It executes test every day with TravisCI. It helps my recognise as soon as possible if it could be wrong. I am looking forward to official API. 🦄

Install

npm install sync-glitch-cli --save-dev

Usage

How to get required environment variables

  1. Open your project on Glitch

  2. Open devtool and click the Network tab

  3. Select Project name > Advanced Options > Import from GitHub

  4. You can find a request URL which starts from https://api.glitch.com/projects/githubImport ~:

    network

  5. It has three params. These params are what you need.

How to set environment variables

You have to set the following environment variables:

  • GLITCH_PROJECT_ID (the Glitch project id.)
  • GLITCH_TOKEN (the Glitch authorization)
  • GH_REPO (the GitHub repo. e.g sotayamashita/sync-glitch-cli)
GLITCH_PROJECT_ID='' GLITCH_TOKEN='' GH_REPO='' ./node_modules/.bin/sync-glitch

Enable debug logs:

GLITCH_PROJECT_ID='' GLITCH_TOKEN='' GH_REPO='' DEBUG=sync-glitch* ./node_modules/.bin/sync-glitch

with Travis CI

# .travis.yml
after_success:
  - npx sync-glitch-cli

with GitHub Action

# .github/main.workflow
workflow "New workflow" {
  on = "push"
  resolves = ["glitch-tools/sync-glitch-github-action@master"]
}

action "glitch-tools/sync-glitch-github-action@master" {
  uses = "glitch-tools/sync-glitch-github-action@master"
  secrets = ["GLITCH_PROJECT_ID", "GLITCH_TOKEN"]
}

Troubleshooting

  • Ensure your repository is NOT empty