Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature: add build caching #14

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Feature: add build caching #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
15d0b29
chore: add frontend caching
jacobfogolyan Apr 22, 2024
77c72ce
feat: add middleware caching
jacobfogolyan Apr 22, 2024
99408c8
chore: update deploy script
jacobfogolyan Apr 22, 2024
ebc2d54
chore: change tag name to version and fix curl req
jacobfogolyan Apr 24, 2024
e80c2cd
chore: re-add nuxt env vars
jacobfogolyan Apr 24, 2024
3799929
chore: build caching for middleware action
jacobfogolyan Jun 7, 2024
81b509e
chore: modify deploy script to be more legible
jacobfogolyan Jun 7, 2024
fd3987d
chore: set npm registry as inputs
jacobfogolyan Jun 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 87 additions & 46 deletions build-frontend/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,81 +2,106 @@ name: Build Frontend
description: Builds Storefront app docker image
inputs:
frontend:
description: 'Switch between Next.js and Nuxt'
description: "Switch between Next.js and Nuxt"
required: false
default: 'next'
default: "next"
project_name:
description: 'Project name'
description: "Project name"
required: true
docker_registry_url:
description: 'Docker registry url'
description: "Docker registry url"
required: false
default: 'registry.vuestorefront.cloud'
default: "registry.storefrontcloud.io"
docker_registry_ref:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't we by default compute the value? It should be like:
${{ inputs.project_name }}-storefrontcloud-io

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it won't build if i use this change unfortunately. i can't seem to reference inputs within the inputs section of this file. it has to be hard coded.

However within the codebase the continuous-delivery.yml file looks like this

docker_registry_ref: ${{ env.DOCKER_REGISTRY_URL }}/${{ env.CUSTOMER_NAME }}-storefrontcloud-io

description: "Docker registry reference"
required: true
cloud_username:
description: 'Cloud username'
description: "Cloud username"
required: true
cloud_password:
description: 'Cloud password'
description: "Cloud password"
required: true
cloud_region:
description: 'Cloud region'
description: "Cloud region"
required: true
npm_email:
description: 'NPM email'
description: "NPM email"
required: true
npm_pass:
description: 'NPM password'
description: "NPM password"
required: true
npm_user:
description: 'NPM user'
description: "NPM user"
required: true
npm_registry:
description: 'NPM registry'
description: "NPM registry"
required: false
default: 'https://registrynpm.storefrontcloud.io'
default: "https://registrynpm.storefrontcloud.io"
api_base_url:
description: 'Base Middleware API URL for Storefront. By default https://project_name.region.gcp.storefrontcloud.io/api'
description: "Base Middleware API URL for Storefront. By default https://project_name.region.gcp.storefrontcloud.io/api"
required: false
multistore_enabled:
description: 'Switch for multistore'
description: "Switch for multistore"
required: false
default: 'false'
default: "false"
image_provider:
description: 'Image provider name'
description: "Image provider name"
required: false
image_provider_upload_url:
description: 'Image Provider upload url'
description: "Image Provider upload url"
required: false
image_provider_fetch_url:
description: 'Image Provider fetch url'
description: "Image Provider fetch url"
required: false
coveo_organization_id:
description: 'Coveo organization id'
description: "Coveo organization id"
required: false
coveo_access_token:
description: 'Coveo access token'
description: "Coveo access token"
required: false
version:
description: 'Version of the app'
required: false
description: "Version of the app"
required: true

runs:
using: 'composite'
using: "composite"
steps:
- name: Setup node
uses: actions/setup-node@v3
# Need buildx for caching
- name: Set up Docker Buildx
id: buildx
uses: docker/setup-buildx-action@v3

- name: Login Alokai Docker Registry
uses: docker/login-action@v3
with:
node-version: 18.x
- name: Build and publish docker image (Next.js frontend)
registry: ${{ inputs.docker_registry_url }}
username: ${{ inputs.npm_user }}
password: ${{ inputs.npm_pass }}

- name: Build and push image (Next.js frontend)
if: ${{ inputs.frontend == 'next' || inputs.frontend == 'nextjs' }}
uses: elgohr/Publish-Docker-Github-Action@v5
uses: docker/build-push-action@v5
with:
name: ${{ inputs.project_name }}-storefrontcloud-io/vue-storefront:${{ inputs.version || github.sha }}
registry: ${{ inputs.docker_registry_url }}
username: ${{ inputs.cloud_username }}
password: ${{ inputs.cloud_password }}
dockerfile: .vuestorefrontcloud/docker/nextjs/Dockerfile-frontend
buildoptions: --compress
buildargs: NPM_EMAIL,NPM_PASS,NPM_USER,NPM_REGISTRY,NEXT_PUBLIC_API_BASE_URL,NEXT_PUBLIC_MULTISTORE_ENABLED,NEXT_IMAGE_PROVIDER,NEXT_PUBLIC_IMAGE_LOADER_FETCH_URL,NEXT_PUBLIC_IMAGE_LOADER_UPLOAD_URL,NEXT_PUBLIC_COVEO_ORGANIZATION_ID,NEXT_PUBLIC_COVEO_ACCESS_TOKEN
context: .
file: .vuestorefrontcloud/docker/nextjs/Dockerfile-frontend
push: true
tags: ${{ inputs.docker_registry_ref }}/vue-storefront:${{ inputs.version }}
# Inline cache
cache-from: "type=registry,ref=${{ inputs.docker_registry_ref }}/vue-storefront:${{ inputs.project_name }}-buildcache"
cache-to: "type=registry,ref=${{ inputs.docker_registry_ref }}/vue-storefront:${{ inputs.project_name }}-buildcache,mode=max"
build-args: |
NPM_EMAIL=${{ inputs.npm_email }}
NPM_PASS=${{ inputs.npm_pass }}
NPM_USER=${{ inputs.npm_user }}
NPM_REGISTRY=${{ inputs.npm_registry }}
NEXT_PUBLIC_API_BASE_URL=${{ inputs.api_base_url || format('https://{0}.{1}.{2}/api', inputs.project_name, inputs.cloud_region, 'gcp.storefrontcloud.io') }}
NEXT_PUBLIC_MULTISTORE_ENABLED=${{ inputs.multistore_enabled }}
NEXT_IMAGE_PROVIDER=${{ inputs.image_provider }}
NEXT_PUBLIC_IMAGE_LOADER_UPLOAD_URL=${{ inputs.image_provider_upload_url }}
NEXT_PUBLIC_IMAGE_LOADER_FETCH_URL=${{ inputs.image_provider_fetch_url }}
NEXT_PUBLIC_COVEO_ORGANIZATION_ID=${{ inputs.coveo_organization_id }}
NEXT_PUBLIC_COVEO_ACCESS_TOKEN=${{ inputs.coveo_access_token }}

env:
NPM_EMAIL: ${{ inputs.npm_email }}
NPM_PASS: ${{ inputs.npm_pass }}
Expand All @@ -89,26 +114,42 @@ runs:
NEXT_PUBLIC_IMAGE_LOADER_FETCH_URL: ${{ inputs.image_provider_fetch_url }}
NEXT_PUBLIC_COVEO_ORGANIZATION_ID: ${{ inputs.coveo_organization_id }}
NEXT_PUBLIC_COVEO_ACCESS_TOKEN: ${{ inputs.coveo_access_token }}
- name: Build and publish docker image (Nuxt frontend)

- name: Build and push
if: ${{ inputs.frontend == 'nuxt' }}
uses: elgohr/Publish-Docker-Github-Action@v5
uses: docker/build-push-action@v5
with:
name: ${{ inputs.project_name }}-storefrontcloud-io/vue-storefront:${{ inputs.version || github.sha }}
registry: ${{ inputs.docker_registry_url }}
username: ${{ inputs.cloud_username }}
password: ${{ inputs.cloud_password }}
dockerfile: .vuestorefrontcloud/docker/nuxtjs/Dockerfile-frontend
buildoptions: --compress
buildargs: NPM_EMAIL,NPM_PASS,NPM_USER,NPM_REGISTRY,NUXT_PUBLIC_API_BASE_URL,NUXT_PUBLIC_MULTISTORE_ENABLED,NUXT_IMAGE_PROVIDER,NUXT_PUBLIC_IMAGE_LOADER_FETCH_URL,NUXT_PUBLIC_IMAGE_LOADER_UPLOAD_URL,NUXT_PUBLIC_COVEO_ORGANIZATION_ID,NUXT_PUBLIC_COVEO_ACCESS_TOKEN
context: .
file: .vuestorefrontcloud/docker/nuxtjs/Dockerfile-frontend
push: true
tags: ${{ inputs.docker_registry_ref }}/vue-storefront:${{ inputs.version }}
# Inline cache
cache-from: "type=registry,ref=${{ inputs.docker_registry_ref }}/vue-storefront:${{ inputs.project_name }}-buildcache"
cache-to: "type=registry,ref=${{ inputs.docker_registry_ref }}/vue-storefront:${{ inputs.project_name }}-buildcache,mode=max"
build-args: |
NPM_EMAIL=${{ inputs.npm_email }}
NPM_PASS=${{ inputs.npm_pass }}
NPM_USER=${{ inputs.npm_user }}
NPM_REGISTRY=${{ inputs.npm_registry }}
NUXT_PUBLIC_API_BASE_URL=https://${{ inputs.project_name }}.${{ inputs.cloud_region }}.gcp.storefrontcloud.io/api/
NUXT_PUBLIC_MULTISTORE_ENABLED=${{ inputs.multistore_enabled }}
NUXT_IMAGE_PROVIDER=${{ inputs.image_provider }}
NUXT_PUBLIC_IMAGE_LOADER_UPLOAD_URL=${{ inputs.image_provider_upload_url }}
NUXT_PUBLIC_IMAGE_LOADER_FETCH_URL=${{ inputs.image_provider_fetch_url }}
NUXT_PUBLIC_COVEO_ORGANIZATION_ID=${{ inputs.coveo_organization_id }}
NUXT_PUBLIC_COVEO_ACCESS_TOKEN=${{ inputs.coveo_access_token }}

env:
NPM_EMAIL: ${{ inputs.npm_email }}
NPM_PASS: ${{ inputs.npm_pass }}
NPM_USER: ${{ inputs.npm_user }}
NPM_REGISTRY: ${{ inputs.npm_registry }}
NUXT_PUBLIC_API_BASE_URL: ${{ inputs.api_base_url || format('https://{0}.{1}.{2}/api', inputs.project_name, inputs.cloud_region, 'gcp.storefrontcloud.io') }}
NUXT_PUBLIC_API_BASE_URL: https://${{ inputs.project_name }}.${{ inputs.cloud_region }}.gcp.storefrontcloud.io/api/
NUXT_PUBLIC_MULTISTORE_ENABLED: ${{ inputs.multistore_enabled }}
NUXT_IMAGE_PROVIDER: ${{ inputs.image_provider }}
NUXT_PUBLIC_IMAGE_LOADER_UPLOAD_URL: ${{ inputs.image_provider_upload_url }}
NUXT_PUBLIC_IMAGE_LOADER_FETCH_URL: ${{ inputs.image_provider_fetch_url }}
NUXT_PUBLIC_COVEO_ORGANIZATION_ID: ${{ inputs.coveo_organization_id }}
NUXT_PUBLIC_COVEO_ACCESS_TOKEN: ${{ inputs.coveo_access_token }}


57 changes: 30 additions & 27 deletions build-middleware/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ inputs:
docker_registry_url:
description: 'Docker registry url'
required: false
default: 'registry.vuestorefront.cloud'
default: "registry.storefrontcloud.io"
docker_registry_ref:
description: "Docker registry reference"
required: true
cloud_username:
description: 'Cloud username'
required: true
Expand All @@ -29,38 +32,38 @@ inputs:
default: 'https://registrynpm.storefrontcloud.io'
version:
description: 'Version of the app'
required: false
required: true

runs:
using: "composite"
steps:
- name: Setup node
uses: actions/setup-node@v3
with:
node-version: 18.x
- name: Encode Basic Auth
id: base64-auth
shell: bash
run: |
echo "BASIC_AUTH_TOKEN=$(echo -n ${{ inputs.cloud_username }}:${{ inputs.cloud_password }} | base64 -w 0)" >> "$GITHUB_OUTPUT"
- name: Check for existing image
id: check-existing-image
uses: javajawa/check-registry-for-image@v2
# Need buildx for caching
- name: Set up Docker Buildx
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to define buildx before caching happens

id: buildx
uses: docker/setup-buildx-action@v3

- name: Login Alokai Docker Registry
uses: docker/login-action@v3
with:
registry: ${{ inputs.docker_registry_url }}
auth: "Basic ${{ steps.base64-auth.outputs.BASIC_AUTH_TOKEN }}"
repository: ${{ inputs.project_name }}-storefrontcloud-io/vue-storefront-middleware
tag: ${{ inputs.version || github.sha }}
- name: Build and publish docker image (middleware)
uses: elgohr/Publish-Docker-Github-Action@v5
if: ${{ steps.check-existing-image.outputs.exists == 'false' }}
username: ${{ inputs.npm_user }}
password: ${{ inputs.npm_pass }}

- name: Build and push
uses: docker/build-push-action@v5
with:
name: ${{ inputs.project_name }}-storefrontcloud-io/vue-storefront-middleware:${{ inputs.version || github.sha }}
registry: ${{ inputs.docker_registry_url }}
username: ${{ inputs.cloud_username }}
password: ${{ inputs.cloud_password }}
dockerfile: .vuestorefrontcloud/docker/middleware/Dockerfile-middleware
buildoptions: --compress
buildargs: NPM_EMAIL,NPM_PASS,NPM_USER,NPM_REGISTRY
context: .
file: .vuestorefrontcloud/docker/middleware/Dockerfile-middleware
push: true
tags: ${{ inputs.docker_registry_ref }}/vue-storefront-middleware:${{ inputs.version }}
# Inline cache
cache-from: "type=registry,ref=${{ inputs.docker_registry_ref }}/vue-storefront-middleware:${{ inputs.project_name }}-buildcache"
cache-to: "type=registry,ref=${{ inputs.docker_registry_ref }}/vue-storefront-middleware:${{ inputs.project_name }}-buildcache,mode=max"
build-args: |
NPM_EMAIL=${{ inputs.npm_email }}
NPM_PASS=${{ inputs.npm_pass }}
NPM_USER=${{ inputs.npm_user }}
NPM_REGISTRY=${{ inputs.npm_registry }}
env:
NPM_EMAIL: ${{ inputs.npm_email }}
NPM_PASS: ${{ inputs.npm_pass }}
Expand Down
Loading