ci: skip production deploys for documentation-only changes - #24
Merged
Merged
Conversation
Merging a README edit rebuilt the image and restarted Keycloak. Harmless in itself, but it is a needless restart of the auth server every product depends on, and it buries real deploys among cosmetic ones in the run history. paths-ignore covers only files that cannot affect the built image or the deployment: markdown, LICENSE, .gitignore, docs/ and .vscode/. Verified that src/, the Dockerfile, package.json, the compose file and this workflow all still trigger a deploy. Also corrects a comment that had become dangerous. It previously said keycloak-staging was kept so the environment could be flipped back "in one line" if the production environment misbehaved. That environment now holds placeholder secrets - it is being kept to be repurposed for a real staging server - so following that advice would break the deploy without saying why: appleboy/ssh-action reports a bad key as an opaque handshake error, not as a credentials problem. The comment now says the opposite, and records that secrets must be added to a target environment before switching to it, because GitHub cannot move them.
This was referenced Sep 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two changes, one of which fixes a comment that had become actively misleading.
1. Documentation changes no longer redeploy production
Merging a README edit (#23) rebuilt the image and restarted Keycloak. Harmless in itself, but it is a needless restart of the auth server every product depends on, and it buries real deploys among cosmetic ones in the run history.
Only files that cannot affect the built image or the deployment. Verified both directions:
src/login/pages/Register.tsxDockerfile,package.jsondeploy/docker-compose.staging.yml.github/workflows/deploy-keycloak-staging.ymlREADME.md,SECURITY.md,LICENSE,.gitignore,docs/**2. Corrects a now-dangerous comment
The
environment:comment previously saidkeycloak-stagingwas kept so it could be flipped back to "in one line" if the production environment misbehaved.That advice is now wrong. That environment holds placeholder secrets — it is being kept to be repurposed for a real staging server later. Following the old comment would break the deploy without explaining why:
appleboy/ssh-actionreports a bad key as an opaque handshake failure, not as a credentials problem, so it would look like a broken box rather than a misrouted environment.The comment now says the opposite, and records the constraint that caused the original two-PR split: GitHub cannot move secrets between environments, so a future switch means adding
EC2_HOST,EC2_USERNAMEandEC2_PRIVATE_KEYto the target first.