-
Notifications
You must be signed in to change notification settings - Fork 13
ci: validate docker config templates against toml examples #163
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ci: validate docker config templates against toml examples #163
Conversation
f361a4a to
d46e273
Compare
d46e273 to
98e5c23
Compare
|
Which commit did you use in your test? Because yesterday I pushed fd245fc which added the new config to the docker templates.. |
Yeah, I saw it. I Just reverted it locally, to see if the script would catch the problem and then reapplied to see if the script stop complaining with the fix from the commit |
98e5c23 to
f3f4b8e
Compare
|
ready for review again. added two new commits:
|
docker/docker-compose.yml
Outdated
| services: | ||
| pool_sv2: | ||
| image: stratumv2/pool_sv2:v0.1.0 | ||
| image: stratumv2/pool_sv2:latest |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is where the “maintainer’s job” that I mentioned in the issue comes into play: when cutting a release, maintainers must update this Docker tag to reference the exact release version being published, ensuring the release points to a stable, immutable image.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess we can do that by adding one single commit directly to the release branch.
Now we are creating the release branch after we push the release, but we should simply switch the order:
- we create release branch
- we add a new commit where we make docker-compose point to the release image
- we add a new commit where we make
stratum-appsandbitcoin_core_sv2fetchstratum-corefrom crates.io (as planned here) - we trigger the release, referencing the release branch instead of
main
In this way we would avoid adding commits on main which would need to be reverted right after the release.
Wdyt @plebhash ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
took note here: #175
0d70601 to
ce7e061
Compare
ce7e061 to
bed08b6
Compare
59933c9 to
38fbcf4
Compare
38fbcf4 to
16326f6
Compare
This adds a GitHub Actions workflow and validation script that compares TOML config examples against their corresponding Docker template files. The check ensures all config keys stay in sync, preventing silent drift between example configs and Dockerized deployments.
…ccording to the branch name
16326f6 to
cc23006
Compare

closes #137
This adds a GitHub Actions workflow and validation script that compares TOML config examples against their corresponding Docker template files.
The check ensures all config keys stay in sync, preventing silent drift between example configs and Dockerized deployments.
This CI does not check the
docker_env.examplefile, because the decision to override values viadocker_envor rely on the default configuration is intentionally left to the implementer.Additionally,
docker-release.ymlwas updated to build and publish themainDocker tag on every PR merged intomainbranch.