Skip to content

Zapier: Build, validate and upload a version from CI on a tag, and promote by hand #48

Open

Description

@johnxie

Problem

The CI workflow (.github/workflows/ci.yml) lints, builds and tests the Zapier app on each push and pull request. No workflow uploads a Zapier version. So nothing ties a live Zapier version to a commit, a tag or a CI run.

The n8n node already has a release workflow. .github/workflows/publish-n8n.yml runs on a tag n8n-v<version>. It checks that the tagged commit is on master and that the tag matches the package version, then it publishes.

What a developer can do today

  • Run yarn lint, yarn build and yarn test locally.
  • Run zapier validate and zapier push from a local machine with access to the Zapier integration.

Proposed change

Add .github/workflows/release-zapier.yml, in the same shape as publish-n8n.yml:

  1. Run on a tag zapier-v<version>, for example zapier-v1.4.0.
  2. Fail if the tagged commit is not on master.
  3. Fail if the tag does not match version in the root package.json.
  4. Run yarn install --frozen-lockfile, yarn lint, yarn build and yarn test.
  5. Run zapier validate with a pinned version of zapier-platform-cli.
  6. Run zapier push with a deploy key from a protected GitHub environment, for example the secret ZAPIER_DEPLOY_KEY.
  7. Stop there. A person tests the new version in the Zapier editor, then runs zapier promote.

Document the release steps in CONTRIBUTING.md, next to the n8n steps.

Done when

  • A tag push uploads the version, and the run log shows zapier validate with no errors.
  • A tag that does not match package.json, or that is not on master, fails before the upload.
  • The workflow never runs zapier promote or zapier migrate.
  • Only the protected environment holds the deploy key.
  • CONTRIBUTING.md lists the release steps, and CHANGELOG.md has an entry for each released version.

Activity

  1. johnxie commented on Nov 19, 2026

    @johnxie
    MemberAuthor

    A note for the first release after #51.

    #51 moved the Zapier app from zapier-platform-core 17.4.0 to 19.3.0. The built definition is the same, except for platformVersion. The next upload is the first one on platform 19, so two things need a check before it:

    1. Use zapier-platform-cli 19 for the upload, and confirm its command name. The release steps in the README still say zapier push.
    2. Platform 18 and later run on Node 22. Run the test suite on Node 22 before the upload.

    The release workflow of this issue is a good place to pin both.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions