Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update version number and readme with more detailed deploy steps #53

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,20 @@ Zapier runs on AWS Lambda and requires Node 8. If you're running never version a
## Developing

- `yarn zapier-validate` - Validates Zapier app content
- `yarn zapier-push` - Deploys the app to Zapier
- `yarn test` - Tests your app

For testing, save your envvars to `.env`. `.env.default` has the required variables listed for development/testing.

### Deployment

Prerequisites:
- Make sure you have updated the version number in `package.json`.
- If updating Linear's app, you'll need to have access to Linear's Zapier account and generate a deploy key in `Settings > Deploy Keys`. You can then authenticate with the key using `zapier login --sso`.

You can deploy the app to Zapier with `yarn zapier-push`. This will also run `yarn zapier-validate` before deploying.

After deploying, you'll need to manually promote the version to 'public' in Zapier's dashboard under `App > Manage > Versions`.

## Forking

If you want to make changes and run your own version of this app, remove `.zapierapprc` file and create a new Zapier app with `zapier register "My app"` under your own Zapier account.
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "linear-zapier",
"version": "2.10.0",
"version": "2.10.1",
"description": "Linear's Zapier integration",
"main": "index.js",
"license": "MIT",
"scripts": {
"zapier-build": "tsc",
"zapier-dev": "tsc --watch",
"zapier-validate": "npm run zapier-build && zapier validate",
"zapier-push": "npm run zapier-build && zapier push",
"zapier-push": "npm run zapier-validate && zapier push",
"prepare": "npm run zapier-build",
"pretest": "npm run zapier-build",
"test": "jest --passWithNoTests lib",
Expand Down