From 4479211211ed2f3ed318ee7b500fe7d1aae0360b Mon Sep 17 00:00:00 2001 From: Elmar Athmer Date: Sat, 18 May 2024 16:00:15 +0200 Subject: [PATCH 1/4] fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 008755d..89637f1 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ commands into [Justfile](./Justfile) recipes which can be executed by CI/CD and but of course it does not know everything. Maybe in the future some practices turn out to be not a good idea, maybe to work with legacy code it's necessary to bend the rules/ideas presented here, maybe you just don't like them. -Feel free to pick the peaces you like and change what you don't like. +Feel free to pick the pieces you like and change what you don't like. ## Environment variables From 5648866f92fe8838c86f2ee2ba087e2378c4f964 Mon Sep 17 00:00:00 2001 From: Elmar Athmer Date: Sat, 18 May 2024 16:03:10 +0200 Subject: [PATCH 2/4] improve readme --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 89637f1..5a3f12b 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,11 @@ > > *Parkway Drive, Wishing wells* -A best-practice example for an Express-NodeJS Microservices, which can be used as a basis for new services. +A best-practice example for an Express-NodeJS microservices that can be used as a foundation for new services. *Wishing-well* relies heavily on [io-ts](https://gcanti.github.io/io-ts/) for environment variables and input validation. -Also, it encourages a functional style outside of handlers (i.e. were feasible) with the help of [fp-ts](https://gcanti.github.io/fp-ts/). So having some idea of functional programming helps. +It also encourages a functional style outside of handlers (i.e., where feasible) with the help of [fp-ts](https://gcanti.github.io/fp-ts/). So having some idea of functional programming helps. ## Sponsors sweap.io @@ -22,15 +22,15 @@ Sponsored and used by [sweap.io](https://sweap.io). - logging via Pino with [request context](https://blog.logrocket.com/logging-with-pino-and-asynclocalstorage-in-node-js/) - input validation with [io-ts](https://gcanti.github.io/io-ts/) - embraces async/await in handlers via [express-promise-router](https://www.npmjs.com/package/express-promise-router) -- config via environment variables -- flexible, custom, semantic error-handling leveraging [cause](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause) -- fast build of slim container-images (leveraging [multi-stage builds](https://docs.docker.com/build/building/multi-stage/)) -- good testability due to (manual) dependency injection -- pragmatic approach to functional programming, cherry-picking the good parts without being too academic +- configuration via environment variables +- flexible, custom, semantic error handling using [cause](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause) +- fast build of slim container images (leveraging [multi-stage builds](https://docs.docker.com/build/building/multi-stage/)) +- good testability through (manual) dependency injection +- pragmatic approach to functional programming, picking the good parts without being too academic ## Required software -- [direnv](https://direnv.net/) to set environment-variables for development (especially `PATH` to execute binaries from installed npm packages) +- [direnv](https://direnv.net/) to set environment variables for development (especially `PATH` to execute binaries from installed npm packages) - [Direnv integration for IntelliJ](https://plugins.jetbrains.com/plugin/15285-direnv-integration) to use environment set via *direnv* for IntelliJ Run - NodeJS > 18 for [Error-cause-property](https://node.green/#ES2022-features-Error-cause-property) - [just](https://just.systems/man/en/) to execute commands From e7b694c31b8970d95f6152112e688803a1950654 Mon Sep 17 00:00:00 2001 From: Elmar Athmer Date: Mon, 6 May 2024 20:29:43 +0200 Subject: [PATCH 3/4] enable dependabot for github-actions --- .github/dependabot.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index d1f0d08..b2c5358 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -4,3 +4,7 @@ updates: directory: "/" schedule: interval: "daily" + - package-ecosystem: github-actions + directory: / + schedule: + interval: weekly From a5d56871e6ee2095f4ac16b95d6bffa7d2c2311b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 18 May 2024 16:55:45 +0000 Subject: [PATCH 4/4] Bump actions/setup-node from 2 to 4 Bumps [actions/setup-node](https://github.com/actions/setup-node) from 2 to 4. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](https://github.com/actions/setup-node/compare/v2...v4) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8a89695..c2758b8 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -17,7 +17,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v2 + uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }}