Integrating GitHub Actions

Add one step at the end of your workflow that creates a Jaws Deploy release tied to the commit you just built.

Search guides... Ctrl K

Jaws Deploy works with GitHub Actions through the REST API or the PowerShell SDK. The shape is the same as any CI integration: build and test in GitHub Actions, then call out at the end of the workflow to create a release.

// Minimal workflow step

Add at the end of an existing workflow

Store the API key in GitHub Actions secrets (Settings -> Secrets and variables -> Actions).

- name: Create Jaws Deploy release
  shell: pwsh
  env:
    JAWS_API_KEY: ${{ secrets.JAWS_API_KEY }}
  run: |
    Install-Module -Name JawsDeploy -Scope CurrentUser -Force
    Connect-JawsDeploy -Url "https://app.jawsdeploy.net" -ApiKey $env:JAWS_API_KEY
    New-JawsDeployRelease `
        -Workspace "default" `
        -Project   "checkout-service" `
        -Version   "${{ github.run_number }}" `
        -Packages  @{ "Checkout.Web" = "${{ github.run_number }}" }

Using the REST API instead

If you prefer not to use PowerShell, the REST API takes the same parameters. Use Basic auth with a service account ID and the API key.

// REST API equivalent

Same outcome, plain curl

curl -X POST "https://app.jawsdeploy.net/api/workspaces/default/projects/checkout-service/releases" \
  -u "$JAWS_SA_ID:$JAWS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "version":  "'"$GITHUB_RUN_NUMBER"'",
    "packages": { "Checkout.Web": "'"$GITHUB_RUN_NUMBER"'" }
  }'