Deprecating two GitHub Actions in favor of the CLI deploy command

[gfscott]

Earlier this year, we introduced the deploy command, which makes it simpler and more flexible to deploy to Oxygen from any context — including from CI/CD platforms other than GitHub.

The deploy command is now replacing Oxygen's previous deployment method, which used two GitHub Actions: shopify/oxygenctl-action and shopify/github-deployment-action. These actions are now deprecated, and we encourage everyone to switch to the deploy command.

Many developers have already received a pull request from Shopify’s GitHub bot to make the required updates automatically, but you can also update manually if required. In most cases, it results in a much simpler workflow:

  - name: Build and Publish to Oxygen
    id: deploy
-   uses: shopify/oxygenctl-action@v4
-   with:
-    oxygen_deployment_token: ${{ secrets.OXYGEN_DEPLOYMENT_TOKEN_0000000000 }}
-     build_command: "npm run build"
- # Create GitHub Deployment
- - name: Create GitHub Deployment
-   uses: shopify/github-deployment-action@v1
-   if: always()
-   with:
-     token: ${{ github.token }}
-     environment: 'preview'
-     preview_url: ${{ steps.deploy.outputs.url }}
-     description: ${{ github.event.head_commit.message }}
+   run: npx shopify hydrogen deploy
+   env:
+     SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN: ${{ secrets.OXYGEN_DEPLOYMENT_TOKEN_0000000000 }}

If your workflow file has more complex customizations, consult the Hydrogen CLI reference for more details on configuring the deploy command.

[Lonswaya]

Our team is struggling with this because despite adding the token to our environment variable or adding it to the command directly, we are still getting the "Log Into Shopify" popup. What could be going wrong here?

[graygilmore]

You shouldn't get the login prompt so long as the command is being run in a CI environment. How are you running it? Can you provide versions the related packages?

[Lonswaya]

This was through Azure Pipelines in particular. It looks like the deploy script assumed that we were not in a CI environment.

We were able to solve this by adding CI: true to our environment variables on the deploy script.

- script: |
    npx shopify hydrogen deploy --force --token $(SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN)
  displayName: Build and Publish to Oxygen
  env:
   CI: true

It looks like Azure Pipelines is not even supported as a CI Platform in cli-kit's ciPlatform, but that's an issue for another day.