v0.0.8 - Githubissues

github-actions[bot] commented 5 days ago

Title

v0.0.8

PR Type

enhancement, bug fix

Description

Optimized Nginx reload process in deployment workflow by replacing Docker stack deploy commands with Docker exec.
Updated several dependencies across multiple projects to newer versions, improving compatibility and performance.
Integrated proxy service configuration into main Docker Compose files, enhancing service dependencies and adding health checks.
Enhanced Keycloak Dockerfile with additional dependencies for improved functionality.
Upgraded Pulumi SDK version to v3.138.0 across multiple projects, updating checksums accordingly.

Changes walkthrough 📝

Relevant files

Enhancement

3 files

deploy-services.yml `Optimize Nginx reload process in deployment workflow` .github/workflows/deploy-services.yml Replaced Docker stack deploy commands with Docker exec to reload Nginx. Removed redundant Docker stack deploy commands.	+1/-4
Dockerfile `Enhance Keycloak Dockerfile with additional dependencies` authnz/keycloak/Dockerfile Added installation of additional RPM packages. Integrated UBI micro build for additional dependencies.	+10/-0
Dockerfile `Add curl installation to APM server Dockerfile` telemetry/apm-server/Dockerfile - Added installation of curl for APM server.	+4/-0

Dependencies

8 files

package.json `Update dependencies for improved compatibility` authnz-theme/package.json Updated several dependencies to newer versions. Improved compatibility with newer React versions.	+5/-5
pnpm-lock.yaml `Synchronize lock file with updated dependencies` authnz-theme/pnpm-lock.yaml Updated lock file to reflect new dependency versions. Ensured compatibility with updated package versions.	+166/-374
go.mod `Upgrade Pulumi SDK version` authnz/go.mod - Updated Pulumi SDK version to v3.138.0.	+1/-1
go.sum `Update checksums for Pulumi SDK upgrade` authnz/go.sum - Updated checksums for Pulumi SDK version change.	+2/-2
go.mod `Upgrade Pulumi SDK version` rollout/go.mod - Updated Pulumi SDK version to v3.138.0.	+1/-1
go.sum `Update checksums for Pulumi SDK upgrade` rollout/go.sum - Updated checksums for Pulumi SDK version change.	+2/-2
go.mod `Upgrade Pulumi SDK version` telemetry/go.mod - Updated Pulumi SDK version to v3.138.0.	+1/-1
go.sum `Update checksums for Pulumi SDK upgrade` telemetry/go.sum - Updated checksums for Pulumi SDK version change.	+2/-2

Configuration changes

3 files

docker-compose.yml `Integrate proxy service and enhance service dependencies` authnz/docker-compose.yml Merged proxy service configuration into main Docker Compose file. Added health checks and dependency management for services.	+47/-2
docker-compose.yml `Integrate proxy service and enhance service dependencies` rollout/docker-compose.yml Integrated proxy service configuration. Added health checks and dependency management for services.	+47/-1
docker-compose.yml `Integrate proxy service and enhance service dependencies` telemetry/docker-compose.yml Integrated proxy service configuration. Added health checks and dependency management for services.	+93/-23

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

github-actions[bot] commented 5 days ago

:tropical_drink: `preview` on authnz/skulpture/shared-authnz

Pulumi report

Previewing update (shared-authnz)

View Live: https://app.pulumi.com/skulpture/authnz/shared-authnz/previews/4a6825f5-af5f-400b-a645-7e81ccb99a57

@ Previewing update......
Downloading plugin gcp-7.38.0: starting
Downloading plugin cloudflare-5.42.0: starting
Downloading plugin cloudflare-5.42.0: done
Downloading plugin gcp-7.38.0: done
Installing plugin cloudflare-5.42.0: starting
Installing plugin gcp-7.38.0: starting
@ Previewing update....
Installing plugin cloudflare-5.42.0: done
Installing plugin gcp-7.38.0: done

@ Previewing update.......................................................................
pulumi:pulumi:Stack authnz-shared-authnz running 
@ Previewing update....
pulumi:pulumi:Stack authnz-shared-authnz  
Resources:
4 unchanged

github-actions[bot] commented 5 days ago

:tropical_drink: `preview` on network/skulpture/shared-infrastructure

Pulumi report

Previewing update (shared-infrastructure)

View Live: https://app.pulumi.com/skulpture/network/shared-infrastructure/previews/582c9191-f37d-4769-82f0-151ca3897985

@ Previewing update.....
Downloading plugin gcp-7.38.0: starting
Downloading plugin digitalocean-4.34.0: starting
Downloading plugin digitalocean-4.34.0: done
Downloading plugin gcp-7.38.0: done
Installing plugin digitalocean-4.34.0: starting
Installing plugin gcp-7.38.0: starting
@ Previewing update....
Installing plugin digitalocean-4.34.0: done
Installing plugin gcp-7.38.0: done

@ Previewing update.........................................................................
pulumi:pulumi:Stack network-shared-infrastructure running 
@ Previewing update....
pulumi:pulumi:Stack network-shared-infrastructure  
Resources:
12 unchanged

github-actions[bot] commented 5 days ago

:tropical_drink: `preview` on telemetry/skulpture/shared-telemetry

Pulumi report

Previewing update (shared-telemetry)

View Live: https://app.pulumi.com/skulpture/telemetry/shared-telemetry/previews/8cda3161-4af6-475f-8d24-b782dfd33daa

@ Previewing update.....
Downloading plugin gcp-7.38.0: starting
Downloading plugin cloudflare-5.42.0: starting
@ Previewing update....
Downloading plugin cloudflare-5.42.0: done
Downloading plugin gcp-7.38.0: done
Installing plugin cloudflare-5.42.0: starting
Installing plugin gcp-7.38.0: starting
Installing plugin cloudflare-5.42.0: done
@ Previewing update....
Installing plugin gcp-7.38.0: done

@ Previewing update................................................................................
pulumi:pulumi:Stack telemetry-shared-telemetry running 
@ Previewing update....
pulumi:pulumi:Stack telemetry-shared-telemetry  
Resources:
4 unchanged

github-actions[bot] commented 5 days ago

:tropical_drink: `preview` on rollout/skulpture/shared-rollout

Pulumi report

Previewing update (shared-rollout)

View Live: https://app.pulumi.com/skulpture/rollout/shared-rollout/previews/68c8a5bd-b14f-4220-961d-4d8136cdaec9

@ Previewing update.......
Downloading plugin cloudflare-5.42.0: starting
Downloading plugin gcp-7.38.0: starting
@ Previewing update....
Downloading plugin cloudflare-5.42.0: done
Installing plugin cloudflare-5.42.0: starting
Downloading plugin gcp-7.38.0: done
Installing plugin gcp-7.38.0: starting
Installing plugin cloudflare-5.42.0: done
@ Previewing update....
Installing plugin gcp-7.38.0: done

@ Previewing update............................................................................
pulumi:pulumi:Stack rollout-shared-rollout running 
@ Previewing update....
pulumi:pulumi:Stack rollout-shared-rollout  
Resources:
4 unchanged

github-actions[bot] commented 5 days ago

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪

🏅 Score: 85

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review

Dependency Update
Multiple dependencies have been updated, including `cmdk`, `lucide-react`, and `tsafe`. Ensure that these updates do not introduce breaking changes or compatibility issues with existing code. New Service Addition
A new `proxy` service has been added to the Docker Compose configuration. Verify that the configuration is correct and that it integrates properly with existing services. New Service Addition
A new `proxy` service has been added to the Docker Compose configuration. Verify that the configuration is correct and that it integrates properly with existing services.

github-actions[bot] commented 5 days ago

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Possible issue	Improve error handling by ensuring the Nginx reload command only runs if the container exists ___ Ensure that the command to reload Nginx only executes if the container is running to avoid potential errors. [.github/workflows/deploy-services.yml [287]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-6a246fa39605c36dda32e5fc90b8399319a12b956fca2d6fd54fa0feae0c4abeR287-R287) ```diff -docker ps -q -f name="${{ env.STACK_NAME }}_proxy" \| xargs -i docker exec '{}' /usr/sbin/nginx -s reload +docker ps -q -f name="${{ env.STACK_NAME }}_proxy" \| xargs -r docker exec '{}' /usr/sbin/nginx -s reload ``` Suggestion importance[1-10]: 8 Why: The suggestion improves error handling by using the '-r' option with 'xargs', which prevents errors if the container is not running, enhancing the robustness of the deployment script.	8
	Ensure the healthcheck command for logstash properly fails on non-2xx responses ___ Verify that the `healthcheck` command for the `logstash` service is appropriate for its expected response. [rollout/docker-compose.yml [129]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-be092be3b541d71eab5969ed2268083690f8982a3f84e80e1ba3035ead16882fR129-R129) ```diff healthcheck: - test: [ "CMD", "curl", "-sf", "-XGET", "http://127.0.0.1:9600" ] + test: [ "CMD", "curl", "--fail", "http://127.0.0.1:9600" ] ``` Suggestion importance[1-10]: 6 Why: The suggestion improves the healthcheck command by using the `--fail` option, which is a good practice for ensuring proper failure handling. However, it does not address any critical issues.	6
	Improve the healthcheck command to simplify exit code handling ___ Ensure that the `healthcheck` command for the `keycloak` service correctly handles the exit codes for failure cases. [authnz/docker-compose.yml [68]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-85f4696189ef3338eada54f07a4ff1ca1f02d1436164c86af2f549df173ba774R68-R68) ```diff healthcheck: - test: [ "CMD-SHELL", "wget --no-verbose --tries=1 --spider http://localhost:8080 \|\| test $$? -eq 8 \|\| exit 1" ] + test: [ "CMD-SHELL", "wget --no-verbose --tries=1 --spider http://localhost:8080 \|\| exit 1" ] ``` Suggestion importance[1-10]: 5 Why: The suggestion simplifies the healthcheck command, but the original command already handles exit codes correctly. This change may not significantly improve functionality.	5
	Review and update the depends_on section to include all required services for proper startup order ___ Ensure that the `depends_on` for the `proxy` service includes all necessary services to avoid startup issues. [authnz/docker-compose.yml [41]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-85f4696189ef3338eada54f07a4ff1ca1f02d1436164c86af2f549df173ba774R41-R41) ```diff depends_on: - keycloak + - other_service_if_needed ``` Suggestion importance[1-10]: 4 Why: While the suggestion prompts a review of dependencies, it lacks specificity and does not provide actionable changes. The impact on functionality is unclear.	4
	Ensure compatibility of new package versions with existing dependencies ___ Verify the compatibility of the new package versions with existing dependencies to prevent potential conflicts. [authnz-theme/package.json [27]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-68029aa7e48a12323f1f226c353a3bd39bcc847c3c7c1473b462904c3bd240efR27-R27) ```diff +"cmdk": "1.0.4", - ``` Suggestion importance[1-10]: 3 Why: While the suggestion is valid, it does not provide a specific code change and is more of a reminder to check compatibility, which has a lower impact on the PR.	3
	Assess for breaking changes in updated package versions to maintain application stability ___ Check for any breaking changes in the updated versions of the packages to ensure stability. [authnz-theme/package.json [30]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-68029aa7e48a12323f1f226c353a3bd39bcc847c3c7c1473b462904c3bd240efR30-R30) ```diff +"lucide-react": "^0.456.0", - ``` Suggestion importance[1-10]: 3 Why: Similar to the previous suggestion, it highlights an important consideration but lacks actionable code changes, resulting in a lower score.	3
Enhancement	Enhance the logstash service configuration with a restart policy for improved reliability ___ Consider adding a `restart` policy to the `logstash` service for better resilience. [telemetry/docker-compose.yml [175]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-a6537addc8ca7f4a881be0eb4c728fcf311c8e0d3f731c6b49e2c14a4672f607R175-R175) ```diff logstash: image: docker.elastic.co/logstash/logstash:${ELK_VERSION} + restart: unless-stopped ``` Suggestion importance[1-10]: 7 Why: Adding a restart policy to the logstash service enhances its resilience and reliability, which is a valuable improvement for service management.	7
Best practice	Use specific versioning for new dependencies to prevent unintended upgrades ___ Consider using a more specific version range for the new dependencies to avoid unexpected updates. [authnz-theme/package.json [68]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-68029aa7e48a12323f1f226c353a3bd39bcc847c3c7c1473b462904c3bd240efR68-R68) ```diff -"typescript-eslint": "^8.13.0", +"typescript-eslint": "8.13.0", ``` Suggestion importance[1-10]: 4 Why: The suggestion promotes a best practice in dependency management, but it does not provide a concrete change in the code, which limits its impact.	4

Category	Suggestion	Score
Possible issue	Improve error handling by ensuring the Nginx reload command only runs if the container exists ___ Ensure that the command to reload Nginx only executes if the container is running to avoid potential errors. [.github/workflows/deploy-services.yml [287]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-6a246fa39605c36dda32e5fc90b8399319a12b956fca2d6fd54fa0feae0c4abeR287-R287) ```diff -docker ps -q -f name="${{ env.STACK_NAME }}_proxy" \| xargs -i docker exec '{}' /usr/sbin/nginx -s reload +docker ps -q -f name="${{ env.STACK_NAME }}_proxy" \| xargs -r docker exec '{}' /usr/sbin/nginx -s reload ``` Suggestion importance[1-10]: 8 Why: The suggestion improves error handling by using the '-r' option with 'xargs', which prevents errors if the container is not running, enhancing the robustness of the deployment script.	8
	Ensure the healthcheck command for logstash properly fails on non-2xx responses ___ Verify that the `healthcheck` command for the `logstash` service is appropriate for its expected response. [rollout/docker-compose.yml [129]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-be092be3b541d71eab5969ed2268083690f8982a3f84e80e1ba3035ead16882fR129-R129) ```diff healthcheck: - test: [ "CMD", "curl", "-sf", "-XGET", "http://127.0.0.1:9600" ] + test: [ "CMD", "curl", "--fail", "http://127.0.0.1:9600" ] ``` Suggestion importance[1-10]: 6 Why: The suggestion improves the healthcheck command by using the `--fail` option, which is a good practice for ensuring proper failure handling. However, it does not address any critical issues.	6
	Improve the healthcheck command to simplify exit code handling ___ Ensure that the `healthcheck` command for the `keycloak` service correctly handles the exit codes for failure cases. [authnz/docker-compose.yml [68]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-85f4696189ef3338eada54f07a4ff1ca1f02d1436164c86af2f549df173ba774R68-R68) ```diff healthcheck: - test: [ "CMD-SHELL", "wget --no-verbose --tries=1 --spider http://localhost:8080 \|\| test $$? -eq 8 \|\| exit 1" ] + test: [ "CMD-SHELL", "wget --no-verbose --tries=1 --spider http://localhost:8080 \|\| exit 1" ] ``` Suggestion importance[1-10]: 5 Why: The suggestion simplifies the healthcheck command, but the original command already handles exit codes correctly. This change may not significantly improve functionality.	5
	Review and update the depends_on section to include all required services for proper startup order ___ Ensure that the `depends_on` for the `proxy` service includes all necessary services to avoid startup issues. [authnz/docker-compose.yml [41]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-85f4696189ef3338eada54f07a4ff1ca1f02d1436164c86af2f549df173ba774R41-R41) ```diff depends_on: - keycloak + - other_service_if_needed ``` Suggestion importance[1-10]: 4 Why: While the suggestion prompts a review of dependencies, it lacks specificity and does not provide actionable changes. The impact on functionality is unclear.	4
	Ensure compatibility of new package versions with existing dependencies ___ Verify the compatibility of the new package versions with existing dependencies to prevent potential conflicts. [authnz-theme/package.json [27]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-68029aa7e48a12323f1f226c353a3bd39bcc847c3c7c1473b462904c3bd240efR27-R27) ```diff +"cmdk": "1.0.4", - ``` Suggestion importance[1-10]: 3 Why: While the suggestion is valid, it does not provide a specific code change and is more of a reminder to check compatibility, which has a lower impact on the PR.	3
	Assess for breaking changes in updated package versions to maintain application stability ___ Check for any breaking changes in the updated versions of the packages to ensure stability. [authnz-theme/package.json [30]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-68029aa7e48a12323f1f226c353a3bd39bcc847c3c7c1473b462904c3bd240efR30-R30) ```diff +"lucide-react": "^0.456.0", - ``` Suggestion importance[1-10]: 3 Why: Similar to the previous suggestion, it highlights an important consideration but lacks actionable code changes, resulting in a lower score.	3
Enhancement	Enhance the logstash service configuration with a restart policy for improved reliability ___ Consider adding a `restart` policy to the `logstash` service for better resilience. [telemetry/docker-compose.yml [175]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-a6537addc8ca7f4a881be0eb4c728fcf311c8e0d3f731c6b49e2c14a4672f607R175-R175) ```diff logstash: image: docker.elastic.co/logstash/logstash:${ELK_VERSION} + restart: unless-stopped ``` Suggestion importance[1-10]: 7 Why: Adding a restart policy to the logstash service enhances its resilience and reliability, which is a valuable improvement for service management.	7
Best practice	Use specific versioning for new dependencies to prevent unintended upgrades ___ Consider using a more specific version range for the new dependencies to avoid unexpected updates. [authnz-theme/package.json [68]](https://github.com/skulpturenz/shared-resources/pull/278/files#diff-68029aa7e48a12323f1f226c353a3bd39bcc847c3c7c1473b462904c3bd240efR68-R68) ```diff -"typescript-eslint": "^8.13.0", +"typescript-eslint": "8.13.0", ``` Suggestion importance[1-10]: 4 Why: The suggestion promotes a best practice in dependency management, but it does not provide a concrete change in the code, which limits its impact.	4

skulpturenz / shared-resources

v0.0.8 #278

Title

PR Type

Description

Changes walkthrough 📝

:tropical_drink: `preview` on authnz/skulpture/shared-authnz

:tropical_drink: `preview` on network/skulpture/shared-infrastructure

:tropical_drink: `preview` on telemetry/skulpture/shared-telemetry

:tropical_drink: `preview` on rollout/skulpture/shared-rollout

PR Reviewer Guide 🔍

PR Code Suggestions ✨

skulpturenz / shared-resources

v0.0.8 #278

Title

PR Type

Description

Changes walkthrough 📝

:tropical_drink: preview on authnz/skulpture/shared-authnz

:tropical_drink: preview on network/skulpture/shared-infrastructure

:tropical_drink: preview on telemetry/skulpture/shared-telemetry

:tropical_drink: preview on rollout/skulpture/shared-rollout

PR Reviewer Guide 🔍

PR Code Suggestions ✨

:tropical_drink: `preview` on authnz/skulpture/shared-authnz

:tropical_drink: `preview` on network/skulpture/shared-infrastructure

:tropical_drink: `preview` on telemetry/skulpture/shared-telemetry

:tropical_drink: `preview` on rollout/skulpture/shared-rollout