Skip to content

Commit

Permalink
build(dependencies): bump the github-actions group across 1 directory…
Browse files Browse the repository at this point in the history
… with 4 updates (#435)

[skip ci]
* build(dependencies): bump the github-actions group across 1 directory with 4 updates

Bumps the github-actions group with 4 updates in the / directory: [wearefrank/ci-cd-templates](https://github.com/wearefrank/ci-cd-templates), [step-security/harden-runner](https://github.com/step-security/harden-runner), [actions/upload-artifact](https://github.com/actions/upload-artifact) and [Codex-/return-dispatch](https://github.com/codex-/return-dispatch).


Updates `wearefrank/ci-cd-templates` from 1.0.4 to 1.0.6
- [Release notes](https://github.com/wearefrank/ci-cd-templates/releases)
- [Changelog](https://github.com/wearefrank/ci-cd-templates/blob/main/CHANGELOG.md)
- [Commits](wearefrank/ci-cd-templates@5ec3076...b55abdd)

Updates `step-security/harden-runner` from 2.9.0 to 2.9.1
- [Release notes](https://github.com/step-security/harden-runner/releases)
- [Commits](step-security/harden-runner@0d38121...5c7944e)

Updates `actions/upload-artifact` from 4.3.4 to 4.3.6
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@0b2256b...834a144)

Updates `Codex-/return-dispatch` from 1.14.0 to 1.15.0
- [Release notes](https://github.com/codex-/return-dispatch/releases)
- [Changelog](https://github.com/Codex-/return-dispatch/blob/main/.release-it.json)
- [Commits](Codex-/return-dispatch@v1.14.0...v1.15.0)

---
updated-dependencies:
- dependency-name: wearefrank/ci-cd-templates
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions
- dependency-name: step-security/harden-runner
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions
- dependency-name: Codex-/return-dispatch
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions
...

Signed-off-by: dependabot[bot] <[email protected]>

* docker-compose to docker compose

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: MLenterman <[email protected]>
  • Loading branch information
dependabot[bot] and MLenterman committed Aug 30, 2024
1 parent 0ebe593 commit 3f2baed
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/bump-ff-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:

jobs:
bump-ff-version:
uses: wearefrank/ci-cd-templates/.github/workflows/ff-version-auto-bumper.yml@5ec30763e8d8eeed008edcac3c6a329367e42760 # 1.0.4
uses: wearefrank/ci-cd-templates/.github/workflows/ff-version-auto-bumper.yml@b55abddef13517a0a6c8625b7913e232b7f5c2df # 1.0.6
secrets:
token: ${{ secrets.WEAREFRANK_BOT_PAT }}
dockerhub-username: ${{ secrets.DOCKERHUB_USERNAME }}
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
version-next: ${{ steps.reference.outputs.next-reference }}
version-next-strict: ${{ steps.reference.outputs.next-reference }}
steps:
- uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0
- uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
with:
disable-sudo: true
egress-policy: block
Expand All @@ -27,10 +27,10 @@ jobs:

- name: Next Reference
id: reference
uses: wearefrank/ci-cd-templates/next-reference@5ec30763e8d8eeed008edcac3c6a329367e42760 #1.0.4
uses: wearefrank/ci-cd-templates/next-reference@b55abddef13517a0a6c8625b7913e232b7f5c2df #1.0.6

ci:
uses: wearefrank/ci-cd-templates/.github/workflows/ci-generic.yml@5ec30763e8d8eeed008edcac3c6a329367e42760 #1.0.4
uses: wearefrank/ci-cd-templates/.github/workflows/ci-generic.yml@b55abddef13517a0a6c8625b7913e232b7f5c2df #1.0.6
needs:
- version-next
secrets:
Expand All @@ -48,7 +48,7 @@ jobs:
- version-next
- ci
steps:
- uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0
- uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
with:
egress-policy: audit

Expand Down Expand Up @@ -104,7 +104,7 @@ jobs:
fi
- name: Upload SoapUI testreports as artifact
uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b #4.3.4
uses: actions/upload-artifact@834a144ee995460fba8ed112a2fc961b36a5ec5a #4.3.6
if: always()
with:
name: reports-soapui-testreports
Expand Down
14 changes: 7 additions & 7 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
version-next-tag: ${{ steps.next-version.outputs.release-tag }}
version-next-type: ${{ steps.next-version.outputs.release-type }}
steps:
- uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0
- uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
with:
disable-sudo: true
egress-policy: audit
Expand All @@ -40,7 +40,7 @@ jobs:
GH_TOKEN: ${{ secrets.WEAREFRANK_BOT_PAT }}

ci:
uses: wearefrank/ci-cd-templates/.github/workflows/ci-generic.yml@5ec30763e8d8eeed008edcac3c6a329367e42760 #1.0.4
uses: wearefrank/ci-cd-templates/.github/workflows/ci-generic.yml@b55abddef13517a0a6c8625b7913e232b7f5c2df #1.0.6
needs: analyze-commits
secrets:
token: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -58,7 +58,7 @@ jobs:
- analyze-commits
- ci
steps:
- uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0
- uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
with:
egress-policy: audit

Expand Down Expand Up @@ -114,7 +114,7 @@ jobs:
fi
- name: Upload SoapUI testreports as artifact
uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b #4.3.4
uses: actions/upload-artifact@834a144ee995460fba8ed112a2fc961b36a5ec5a #4.3.6
if: always()
with:
name: reports-soapui-testreports
Expand All @@ -127,7 +127,7 @@ jobs:
- ci
- run-soapui-tests
steps:
- uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0
- uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
with:
egress-policy: audit

Expand Down Expand Up @@ -163,7 +163,7 @@ jobs:
GH_TOKEN: ${{ secrets.WEAREFRANK_BOT_PAT }}

docker-release:
uses: wearefrank/ci-cd-templates/.github/workflows/docker-release-generic.yml@5ec30763e8d8eeed008edcac3c6a329367e42760 #1.0.4
uses: wearefrank/ci-cd-templates/.github/workflows/docker-release-generic.yml@b55abddef13517a0a6c8625b7913e232b7f5c2df #1.0.6
needs:
- analyze-commits
- release
Expand Down Expand Up @@ -193,4 +193,4 @@ jobs:
- release
# Set to true to enable Docusaurus publishing to GitHub Pages
if: true
uses: wearefrank/ci-cd-templates/.github/workflows/docusaurus-release.yml@5ec30763e8d8eeed008edcac3c6a329367e42760 #1.0.4
uses: wearefrank/ci-cd-templates/.github/workflows/docusaurus-release.yml@b55abddef13517a0a6c8625b7913e232b7f5c2df #1.0.6
2 changes: 1 addition & 1 deletion .github/workflows/update-helm-chart.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Dispatch an action and get the run ID
uses: Codex-/return-dispatch@v1.14.0
uses: Codex-/return-dispatch@v1.15.0
id: return_dispatch
with:
token: ${{ secrets.token }}
Expand Down
28 changes: 14 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Execute the following steps when bumping the Frank!Framework version:
4. Replace the default value for `FF_VERSION` under `services.zaakbrug.build.args` in `docker-compose.zaakbrug.dev.yml` with the new tag. NOTE: Watch out to not replace the '-' in front of the tag: ${FF_VERSION:-<new tag>}
5. Replace the value of `ff.version` in `frank-runner.properties` with the new tag.
6. Start ZaakBrug with the `Frank!Runner` to automatically replace the `./src/main/configuration/<configuration-name>/FrankConfig.xsd` and `./src/main/configuration/FrankConfig.xsd` with the newer version. You can stop the Frank!Runner once the files are replaced. Note that currently the Frank!Runner will also add `FrankConfig.xsd` to the `.gitignore` file. Make sure to revert the change to `.gitignore`.
7. Run the e2e testsuite by using the below Docker-Compose and configuration to validate the changes. You should only need `docker-compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.openzaak.dev.yml up --build --force-recreate` for this. (TODO: Automate running of e2e tests in ci/cd).
7. Run the e2e testsuite by using the below Docker-Compose and configuration to validate the changes. You should only need `docker compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.openzaak.dev.yml up --build --force-recreate` for this. (TODO: Automate running of e2e tests in ci/cd).
8. Commit you changes on a branch with as message: `build(dependencies): bump f!f version to <new tag>`. Create a PR to have your changes merged to master.

## Docusaurus version
Expand Down Expand Up @@ -56,7 +56,7 @@ When you have imported the tests you can run any test case under the TestSuite,

## Running test cases automatically in Docker container on your local
If you would like to run the test cases which are already prepared in the repo automatically in the docker container on your local then the command would be as follows:
`docker-compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.openzaak.dev.yml --profile soapui up --build`
`docker compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.openzaak.dev.yml --profile soapui up --build`
This command will first have Zaakbrug and Openzaak up and running and afterwards it will automatically run the SoapUI test cases in 'soapui-testrunner' docker container.
The test reports will be created under "./e2e/reports" folder.

Expand All @@ -66,9 +66,9 @@ In case you would like to do any change on Zaakbrug project you can create a PR


# Docker-compose
The docker-compose development environment is designed to be flexible and composable. This prevents the need for developers to run the entire stack eventhough their work requires only a small part of the stack. For this we make use of a docker-compose feature that merges a given array of docker-compose files together. Simply provide a `-f ./docker-compose.<application>.yml` argument for each docker-compose file you wish to include in the `docker-compose up`command.
The docker compose development environment is designed to be flexible and composable. This prevents the need for developers to run the entire stack eventhough their work requires only a small part of the stack. For this we make use of a docker compose feature that merges a given array of docker compose files together. Simply provide a `-f ./docker-compose.<application>.yml` argument for each docker compose file you wish to include in the `docker compose up`command.

To run the entire stack the command would be `docker-compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.zaakbrug.staging.dev.yml -f ./docker-compose.openzaak.dev.yml -f ./docker-compose.openforms.dev.yml up --build`
To run the entire stack the command would be `docker compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.zaakbrug.staging.dev.yml -f ./docker-compose.openzaak.dev.yml -f ./docker-compose.openforms.dev.yml up --build`

> WARNING: It is important to use `host.docker.internal` instead of the usual `localhost`. The url-validator that is used by most components with invalidate any urls that contain only a hostname. It requires a full canonical domain name.
Expand Down Expand Up @@ -97,31 +97,31 @@ ZaakBrug Console can accessed from `host.docker.internal:9000/zaakbrug/`
ZaakBrug is also exposed on `host.docker.internal:8080/`

#### Configuration
By default ZaakBrug uses a filebased H2 database for storing the last used zaak and documenten identifiers. To facilitate easy swapping between development with docker-compose and the Frank!Runner, the default mount for the database file is `../frank-runner/data`. Using the same database file between the Frank!Runner and docker-compose prevents errors surrounding duplicate identifiers while running tests against OpenZaak. If you don't have the Frank!Runner installed, you can use `./data` that is commented out instead or add a volume for it.
By default ZaakBrug uses a filebased H2 database for storing the last used zaak and documenten identifiers. To facilitate easy swapping between development with docker compose and the Frank!Runner, the default mount for the database file is `../frank-runner/data`. Using the same database file between the Frank!Runner and docker compose prevents errors surrounding duplicate identifiers while running tests against OpenZaak. If you don't have the Frank!Runner installed, you can use `./data` that is commented out instead or add a volume for it.

### Postgres
Instead of the default filebased H2 database, a Postgresql database can be used too. Adding `-f ./docker-compose.zaakbrug.postgres.yml` to your `docker-compose up` command is all that is needed for this.
Instead of the default filebased H2 database, a Postgresql database can be used too. Adding `-f ./docker-compose.zaakbrug.postgres.yml` to your `docker compose up` command is all that is needed for this.

For example: `docker-compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.zaakbrug.postgres.yml up --build`
For example: `docker compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.zaakbrug.postgres.yml up --build`

> Note: Database data is not seamlessly shared with the Frank!Runner out-off-the-box. In `src/webapp/META_INF/context.xml` you can comment out the H2 configuration and uncomment the Postgress one. The Frank!Runner will then use the Postgres database used in the docker-compose.
#### PgAdmin4
To aid with debugging you can use PgAdmin4 to browse/edit the Postgres database. PgAdmin4 is included and pre-configured in `docker-compose.zaakbrug.postgres` and can be enabled by adding `--profile pgadmin` to your `docker-compose up` command.
To aid with debugging you can use PgAdmin4 to browse/edit the Postgres database. PgAdmin4 is included and pre-configured in `docker-compose.zaakbrug.postgres` and can be enabled by adding `--profile pgadmin` to your `docker compose up` command.

The PgAdmin4 web-GUI is exposed on port `5050`, so can be accessed with `localhost:5050` or `host.docker.internal:5050`

**default login:**
email: `[email protected]`
password: `admin`

For example: `docker-compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.zaakbrug.postgres.yml --profile pgadmin up --build`
For example: `docker compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.zaakbrug.postgres.yml --profile pgadmin up --build`

### SoapUI
As mentioned under *'Running test cases automatically in Docker container on your local'* under *'Testing with SoapUI'* section we could run SoapUI application in a Docker container. Afterwards, we could run our test cases in this SoapUI application automatically in this container. This is why we created **soapui-testrunner** service in docker-compose.zaakbrug.dev.yml file.
#### soapui-testrunner
To be able to use this service and to run the test cases automatically use the following command which is also mentioned under *'Running test cases automatically in Docker container on your local'* section:
`docker-compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.openzaak.dev.yml --profile soapui up --build`
`docker compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.openzaak.dev.yml --profile soapui up --build`

## docker-compose.zaakbrug.staging.dev
Contains an instance of OpenZaak specifically configured to act as cache or staging for ZGW to ZDS translations. It shares a network with ZaakBrug, and should be considered a component of the ZaakBrug deployment for when ZGW to ZDS translations are required.
Expand Down Expand Up @@ -173,17 +173,17 @@ Running Sentry for the first time requires some configuration.

TODO: Automate configuration

1. Makes sure the `docker-compose.sentry.dev.yml` is included in your ` docker-compose up` and is running.
2. Open a CMD or Powershell in this repository folder and run `docker-compose -f ./docker-compose.sentry.dev.yml exec sentry sentry upgrade`.
1. Makes sure the `docker-compose.sentry.dev.yml` is included in your ` docker compose up` and is running.
2. Open a CMD or Powershell in this repository folder and run `docker compose -f ./docker-compose.sentry.dev.yml exec sentry sentry upgrade`.
3. After approx. a minute you will get asked if you want to create a user account. Choose `y` and hit enter.
4. We use the following defaults: email=`[email protected]`, password: `admin`.
5. Once finished, run the command: `docker-compose -f ./docker-compose.sentry.dev.yml restart sentry` to restart the sentry container.
5. Once finished, run the command: `docker compose -f ./docker-compose.sentry.dev.yml restart sentry` to restart the sentry container.
6. Open a browser and navigate to `host.docker.internal:9500` or `localhost:9500`. You should see the Sentry login page. Login we the email and password from step 4.
7. Make sure the root url is `http://host.docker.internal:9500` and choose `Please keep my usage information anonymous` under Usage Statistics.
8. In the top-right corner hit the `add...` button and choose `project`.
9. Select the appropriate platform. For OpenZaak, ZaakBrug-Staging and OpenForms this will be `Django`. Change the project name appropriately and hit the `Create Project` button.
10. On the next page look for the word `dsn` and copy the value.
11. In the appropriate docker-compose file, add the following to the environment variables of the `open-zaak`, `zaakbrug-staging` and/or `open-forms` service:
11. In the appropriate docker compose file, add the following to the environment variables of the `open-zaak`, `zaakbrug-staging` and/or `open-forms` service:
```
- SENTRY_DSN=<Your copied DSN from step 10>
- SDK_SENTRY_DSN=<Your copied DSN from step 10>
Expand Down

0 comments on commit 3f2baed

Please sign in to comment.