Oxygen Deployment Token

Oxygen Deployment Token

Eltrino
Shopify Partner
15 0 10

Hello Community,

 

We want to automate deployments to Oxygen. All documentation indicates that this should be done from GitHub. However, the issue is that all our repositories are hosted on Bitbucket, and we wish to use its pipelines for automation.

 

I see that the CLI command can work with pipeline environment variables, as stated in the @shopify/oxygen-cli documentation.

 

The only issue I have is determining where I can find the deployment token. It's not clear where this token can be obtained. I'm able to deploy locally using the shopify hydrogen deploy command. Could anybody help me figure out how to obtain this token?

Replies 3 (3)

Liam
Shopify Staff
2873 312 820

HI Eltrino,

 

You can get this token in your partner dashboard by going to Settings > CLI token > Manage tokens > Generate new token. 

 

 

Liam | Developer Advocate @ Shopify 
 - Was my reply helpful? Click Like to let me know! 
 - Was your question answered? Mark it as an Accepted Solution
 - To learn more visit Shopify.dev or the Shopify Web Design and Development Blog

Eltrino
Shopify Partner
15 0 10

Hi Liam,

 

Thank you for your advice. I've generated that token and tried it with both the Shopify Hydrogen CLI command and Oxygen Cli. Both returned the same error: "Error processing deployment token. Please check your token and try again." when I used that token as the value for the -t parameter. The debug log file did not contain any additional useful information.

 

Is there any way to debug if token supplied correctly?

 

UPDATE: Forgot to mention that i'm trying to deploy our clients shop, not our development shop. May be it should be some how assigned to shop?

Eltrino
Shopify Partner
15 0 10

We tried to debug this ourselves. We checked the deployment code and it looks like the token is a base64 encoded JSON object which should contain the actual token and other information.  CLI token from Settings > CLI token, is not.

 

To investigate further, open and modify the file node_modules/@shopify/cli-hydrogen/dist/commands/hydrogen/deploy.js:

 

    }
    token = token || deploymentData.oxygenDeploymentToken;
  }
  conbsole.log(token); // add this line to see the token
  if (!token) {
    const errMessage = ci.isCI ? [

 

After this, when the deployment is started through shopify hydrogen deploy, you will see the token. This token can then be used in oxygen-cli and in pipelines.

 

I hope this information will be helpful to someone.