Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 2.98 KB

release-workflow.md

File metadata and controls

41 lines (29 loc) · 2.98 KB
Raw

Release Workflow

Trigger

Schedule (every 5 minutes) or push to main branch.

Development

With ENVIRONMENT=DEBUG in environment, the script doesn't publish but outputs the commands that would be run. A publish is only triggered when ENVIRONMENT=PRODUCTION is set.

Entry point to test development is npm run vsce:check <channel>, where channel=dev|latest.

Steps

  1. Defined in the file .github/workflows/publish.yml
  2. npm run vsce:check <channel> is run twice with "dev" and "latest" as channels respectively. Internally, it calls check-update.sh <channel>

Note the both dev workflow and latest workflow call the same scripts, the channel variable acts as a workflow discriminator as both workflows have slight differences, now we list the workflow steps in details:

Dev workflow

  1. npm run vsce:check dev calls check-update.sh dev
  2. check-update.sh sets up the repo with Prismo bot as the user, all commits in the remainder of this workflow are attributed to Prismo.
  3. check-update.sh compares CURRENT_VERSION (extension) against NPM_VERSION of Prisma CLI.
  4. If they are same, this script exits
  5. If they are different, bump.sh <channel> <version> is called with channel=dev and version=NPM_VERSION (i.e. the new version of extension to publish)
  6. bump.sh updates the package.json files in root, client, server and sets name, displayName, version, dependencies.@prisma/* packages, and prisma.enginesVersion values.
  7. check-update.sh then commits these changes, this commit is required because vsce publish (to be run later requires a clean git state)
  8. npm run vsce:publish <channel> <version> i.e. publish.sh <channel> <version> is then called with channel=dev and version=NPM_VERSION (i.e. the new version of extension to publish). This command publishes the "Prisma Dev" extension.
  9. publish.sh pushes to vscode main repo. Only changes from the dev channel are pushed.

Latest workflow

  1. npm run vsce:check latest calls check-update.sh latest
  2. check-update.sh sets up the repo with Prismo bot as the user, all commits in the remainder of this workflow are attributed to Prismo.
  3. check-update.sh compares CURRENT_VERSION (extension) against NPM_VERSION of Prisma CLI.
  4. If they are same, this script exits
  5. If they are different, bump.sh <channel> <version> is called with channel=latest and version=NPM_VERSION (i.e. the new version of extension to publish)
  6. bump.sh updates the package.json files in root, client, server and sets name, displayName, version, dependencies.@prisma/* packages, and prisma.enginesVersion values.
  7. check-update.sh then commits these changes, this commit is required because vsce publish (to be run later requires a clean git state)
  8. npm run vsce:publish <channel> <version> i.e. publish.sh <channel> <version> is then called with channel=latest and version=NPM_VERSION (i.e. the new version of extension to publish). This command published the "Prisma" extension.