From b53e9950a7aa70946b9ec1fc9c65420c70b6cb7d Mon Sep 17 00:00:00 2001 From: Victor Fernandez de Alba Date: Mon, 3 Jun 2024 23:13:33 +0200 Subject: [PATCH] Fix paths for GHA, fix README references to commands --- .../.github/workflows/acceptance.yml | 5 +- .../.github/workflows/code.yml | 1 + .../.github/workflows/i18n.yml | 1 + .../.github/workflows/storybook.yml | 1 + .../.github/workflows/unit.yml | 1 + .../README.md | 46 +++++++++++-------- 6 files changed, 33 insertions(+), 22 deletions(-) diff --git a/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/acceptance.yml b/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/acceptance.yml index 5b9e887..26c4427 100644 --- a/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/acceptance.yml +++ b/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/acceptance.yml @@ -5,6 +5,7 @@ on: - "*.js" - "*.json" - "*.yaml" + - "*.yml" - "cypress/**" - "packages/**" @@ -59,8 +60,8 @@ jobs: name: Start Servers with: run: | - make start-test-acceptance-server-ci & - make start-test-acceptance-frontend & + make ci-acceptance-backend-start & + make acceptance-frontend-prod-start & # your step-level and job-level environment variables are available to your commands as-is # npm install will count towards the wait-for timeout # whenever possible, move unrelated scripts to a different step diff --git a/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/code.yml b/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/code.yml index b443cb7..7f878a3 100644 --- a/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/code.yml +++ b/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/code.yml @@ -5,6 +5,7 @@ on: - "*.js" - "*.json" - "*.yaml" + - "*.yml" - "packages/**" env: diff --git a/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/i18n.yml b/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/i18n.yml index adb3f51..558d9ec 100644 --- a/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/i18n.yml +++ b/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/i18n.yml @@ -5,6 +5,7 @@ on: - "*.js" - "*.json" - "*.yaml" + - "*.yml" - "packages/**" env: diff --git a/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/storybook.yml b/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/storybook.yml index 5bb5a90..5a98e3c 100644 --- a/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/storybook.yml +++ b/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/storybook.yml @@ -5,6 +5,7 @@ on: - "*.js" - "*.json" - "*.yaml" + - "*.yml" - "packages/**" - ".github/workflows/storybook.yml" diff --git a/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/unit.yml b/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/unit.yml index eb672f8..b018a5f 100644 --- a/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/unit.yml +++ b/frontend_addon/{{ cookiecutter.__folder_name }}/.github/workflows/unit.yml @@ -5,6 +5,7 @@ on: - "*.js" - "*.json" - "*.yaml" + - "*.yml" - "packages/**" env: diff --git a/frontend_addon/{{ cookiecutter.__folder_name }}/README.md b/frontend_addon/{{ cookiecutter.__folder_name }}/README.md index 9538cde..1c1cd7b 100644 --- a/frontend_addon/{{ cookiecutter.__folder_name }}/README.md +++ b/frontend_addon/{{ cookiecutter.__folder_name }}/README.md @@ -95,21 +95,27 @@ For this reason, it only works with pnpm and Volto 18 (currently in alpha). Run `make help` to list the available commands. ```text -help Show this help -install Installs the dev environment using mrs-developer -i18n Sync i18n -format Format codebase -lint Lint Codebase -test Run unit tests -test-ci Run unit tests in CI -storybook-start Start Storybook server on port 6006 -storybook-build Build Storybook -start-backend-docker Starts a Docker-based backend for developing -start-test-acceptance-frontend-dev Start acceptance frontend in dev mode -start-test-acceptance-frontend Start acceptance frontend in prod mode -start-test-acceptance-server Start acceptance server -test-acceptance Start Cypress in interactive mode -test-acceptance-headless Run cypress tests in headless mode for CI +help Show this help +install Installs the add-on in a development environment +start Starts Volto, allowing reloading of the add-on during development +build Build a production bundle for distribution of the project with the add-on +i18n Sync i18n +ci-i18n Check if i18n is not synced +format Format codebase +lint Lint, or catch and remove problems, in code base +release Release the add-on on npmjs.org +release-dry-run Dry-run the release of the add-on on npmjs.org +test Run unit tests +ci-test Run unit tests in CI +backend-docker-start Starts a Docker-based backend for development +storybook-start Start Storybook server on port 6006 +storybook-build Build Storybook +acceptance-frontend-dev-start Start acceptance frontend in development mode +acceptance-frontend-prod-start Start acceptance frontend in production mode +acceptance-backend-start Start backend acceptance server +ci-acceptance-backend-start Start backend acceptance server in headless mode for CI +acceptance-test Start Cypress in interactive mode +ci-acceptance-test Run cypress tests in headless mode for CI ``` ### Development environment set up @@ -125,13 +131,13 @@ make install Start the backend. ```shell -make backend-start-docker +make backend-docker-start ``` In a separate terminal session, start the frontend. ```shell -pnpm start +make start ``` ### Lint code @@ -173,19 +179,19 @@ Run each of these steps in separate terminal sessions. In the first session, start the frontend in development mode. ```shell -make start-test-acceptance-frontend-dev +make acceptance-frontend-dev-start ``` In the second session, start the backend acceptance server. ```shell -make start-test-acceptance-server +make acceptance-backend-start ``` In the third session, start the Cypress interactive test runner. ```shell -make test-acceptance +make acceptance-test ``` ## License