Shopify / lighthouse-ci-action

MIT License
100 stars 50 forks source link

Unclear authentication documentation #35

Closed mkromann closed 2 years ago

mkromann commented 2 years ago

I cannot figure out what the app_id and app_password refers to. The documentation mentions that it is the same as for ThemeKit, however, all documentation I can find says that ThemeKit has been replaced by Shopify CLI. It's not something I have encountered before now while developing my version of Dawn. Do I still need to utilise ThemeKit to get id and password for this workflow? If that is the case, it's still not clear to me how to get these credentials with ThemeKit.

I am NOT using the Partner Dashboard for development (I don't know if that is relevant at all).

I hope you can clear it up for me.

Thank you, Magnus

muriloshimizu commented 2 years ago

I too would like to start using this, but the authentication process is unclear. Previously with theme kit, we would create a private app in the shopify store. However, private apps no longer exist, and the themekit documentation mentions a themekit app for Shopify. Do I need to install that? No other option?

muriloshimizu commented 2 years ago

Hi @mkromann, I think I found out how to do this.

1) Create a Custom App (Shopify store > Apps > Develop Apps for your store > Create an app > Custom app)

2) On the Custom App you created, Go to API Credentials, and grab the admin api access token and the api secret key. Ignore the api key.

3) On your GitHub Secrets add the following secrets: SHOP_APP_ID: this is the admin api access token from the custom app SHOP_APP_PASSWORD: this is the api secret key (below the api key) from the custom app

Note: I'm not exactly sure what access scopes you need. I added access to everything (cause I was frustrated) and it worked, but I'm sure you won't need all. But anyway, it should allow you to continue testing your Lighthouse CI Action.

modulareverything commented 2 years ago

I created a PR with your instructions @muriloshimizu so hopefully, someone can merge it

https://github.com/Shopify/lighthouse-ci-action/pull/37