Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bravetheskies/shopify-rapid-deploy-action
A GitHub action for rapid deployment of Shopify themes.
https://github.com/bravetheskies/shopify-rapid-deploy-action
github-actions keep shopify shopify-theme shopify-themes themekit workflow
Last synced: 12 days ago
JSON representation
A GitHub action for rapid deployment of Shopify themes.
- Host: GitHub
- URL: https://github.com/bravetheskies/shopify-rapid-deploy-action
- Owner: bravetheskies
- License: mit
- Created: 2021-01-13T16:28:57.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-23T11:57:20.000Z (over 1 year ago)
- Last Synced: 2024-09-30T08:47:30.385Z (about 1 month ago)
- Topics: github-actions, keep, shopify, shopify-theme, shopify-themes, themekit, workflow
- Language: Shell
- Homepage:
- Size: 10.7 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shopify Rapid Deploy Action
A GitHub action for rapid deployment of Shopify themes.
## Usage
The action requires 4 environment variables to run and has one optional variable, they are listed below.
* `SHOPIFY_APP_API_PASSWORD` - API password for your Shopify app.
* `SHOPIFY_STORE_URL` - The store URL in format `my-store.myshopify.com` of your store.
* `SHOPIFY_THEME_ID` - The ID of the theme to deploy to.
* `THEME_PATH` - The path of your theme in your repository. If root use `./`.
* `THEMEKIT_FLAGS` (optional) - [Shopify Theme Kit configuration flags](https://shopify.github.io/themekit/configuration/#flags).
It is recommended that you use [encrypted secrets](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) for your environment details.
They can easily be used in your workflow configuration like so:
```yml
...
- uses: bravetheskies/shopify-rapid-deploy-action@v1
env:
SHOPIFY_APP_API_PASSWORD: ${{ secrets.SHOPIFY_APP_API_PASSWORD }}
SHOPIFY_STORE_URL: ${{ secrets.SHOPIFY_STORE_URL }}
SHOPIFY_THEME_ID: ${{ secrets.SHOPIFY_THEME_ID }}
THEME_PATH: ${{ secrets.SHOPIFY_THEME_PATH }}
...
```
## Examples
Basic full workflow example:
```yml
name: Deploy theme
on: [workflow_dispatch]
jobs:
build:
name: Deploy theme
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@main
- name: Deploy theme
uses: bravetheskies/shopify-rapid-deploy-action@main
env:
SHOPIFY_APP_API_PASSWORD: ${{ secrets.SHOPIFY_APP_API_PASSWORD }}
SHOPIFY_STORE_URL: ${{ secrets.SHOPIFY_STORE_URL }}
SHOPIFY_THEME_ID: ${{ secrets.SHOPIFY_THEME_ID }}
THEME_PATH: ${{ secrets.SHOPIFY_THEME_PATH }}
```
Example with flags from [Shopify Theme Kit configuration](https://shopify.github.io/themekit/configuration/#flags):
```yml
name: Deploy theme
on: [workflow_dispatch]
jobs:
build:
name: Deploy theme
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@main
- name: Deploy theme
uses: bravetheskies/shopify-rapid-deploy-action@main
env:
SHOPIFY_APP_API_PASSWORD: ${{ secrets.SHOPIFY_APP_API_PASSWORD }}
SHOPIFY_STORE_URL: ${{ secrets.SHOPIFY_STORE_URL }}
SHOPIFY_THEME_ID: ${{ secrets.SHOPIFY_THEME_ID }}
THEME_PATH: ${{ secrets.SHOPIFY_THEME_PATH }}
THEMEKIT_FLAGS: --ignored-file=config/settings_data.json --ignored-file=locales/*
```