Skip to content

Commit

Permalink
Merge pull request #918 from plone/acsr-patch-training-deploy-buildin…
Browse files Browse the repository at this point in the history
…g-docker-images-make-test

Update deploy - add more explicit details to invoke and use `make test` command.md
stevepiercy authored Jan 28, 2025
2 parents 95725b9 + 504310a commit d51e070
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions docs/plone-deployment/deploy.md
Original file line number Diff line number Diff line change
@@ -26,15 +26,34 @@ You can find this stack at {file}`devops/stacks/ploneconf2024-<your-github-usern

## Building Docker Images

Ensure you build the Docker images for the Frontend and Backend servers before deployment. GitHub Actions, configured in {file}`.github/workflows/backend.yml` and {file}`.github/workflows/frontend.yml`, facilitate this process.
Ensure you build the Docker images for the Frontend and Backend servers before deployment.
GitHub Actions, configured in {file}`.github/workflows/backend.yml` and {file}`.github/workflows/frontend.yml`, facilitate this process.

````{important}
Before deploying, push all code changes and ensure GitHub Actions successfully complete their runs. Execute these commands to format the code and run tests:
Before deploying, run the following commands from your project's root directory to format the code and run tests.
```shell
make check
make test
```
The output from `make test` may vary according to changes in code.
The following console output indicates that no tests were run, and prompts you to choose an action.
```console
No tests found related to files changed since last commit.
Press `a` to run all tests, or run Jest with `--watchAll`.
Watch Usage
› Press a to run all tests.
› Press f to run only failed tests.
› Press p to filter by a filename regex pattern.
› Press t to filter by a test name regex pattern.
› Press q to quit watch mode.
› Press Enter to trigger a test run.
```
After these commands succeed, commit all code changes, push to GitHub, and ensure all GitHub Actions successfully complete their runs.
````


@@ -44,7 +63,7 @@ Utilize the {file}`Makefile` at {file}`devops/Makefile` for manual deployment.

### Deploying the Stack

Execute the following command to deploy the stack defined in {file}`devops/stacks/ploneconf2024-<your-github-username>.tangrama.com.br.yml` to the remote server:
Execute the following command from your project's {file}`devops` directory to deploy the stack defined in {file}`devops/stacks/ploneconf2024-<your-github-username>.tangrama.com.br.yml` to the remote server.

```shell
make stack-deploy

0 comments on commit d51e070

Please sign in to comment.