docs: runner deployment env, token persistence, and QA case accuracy#3866
Draft
cursor[bot] wants to merge 1 commit into
Draft
docs: runner deployment env, token persistence, and QA case accuracy#3866cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
Conversation
- Document runner-wrapper registration flow, SEMAPHORE_DATA_PATH default, token file mutual exclusion, and accurate SEMAPHORE_WEB_ROOT usage. - Cross-link Docker runner README to compose runner notes. - Align TC-027 expected results with token_file vs config.json persistence. - Fix CONTRIBUTING Dredd numbered step formatting. Co-authored-by: Denis Gukov <fiftin@outlook.com>
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
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.
Summary
Documentation-only updates aligned with recent runner/Docker behavior and developer onboarding.
Docs added/updated
deployment/compose/README.md— New Runner environment subsection:SEMAPHORE_WEB_ROOTvs unusedSEMAPHORE_RUNNER_API_URLin the sample compose file, official image entrypoint (runner-wrapper), registration env vars (SEMAPHORE_RUNNER_REGISTRATION_TOKEN/_FILE), defaultSEMAPHORE_RUNNER_TOKEN_FILEunderSEMAPHORE_DATA_PATH, persistence guidance, and mutual exclusion ofSEMAPHORE_RUNNER_TOKENvsSEMAPHORE_RUNNER_TOKEN_FILE.deployment/docker/README.md— New Runner image section summarizingrunner-wrapperand pointing to the compose README for persistence/token details.test/test-cases/TC-027-runner-register.md— Expected results updated so token persistence matches real paths (config.jsonrunner.token,token_file/ env, or Docker--no-configdefaultrunner_token.txt).CONTRIBUTING.md— Dredd local steps: fixed duplicate step numbering / fence indentation for starting the server.Codepaths covered
deployment/docker/runner/runner-wrapper— defaults and registration branch.util/config.go—SEMAPHORE_WEB_ROOT, runner token / token file loading and panic when both token sources are set.services/runners/job_pool.go— URL construction fromWebHost, writing the issued token totoken_filewhen configured.Knowledge gaps addressed
--no-configflows vs JSON config./var/lib/semaphore(or an explicitSEMAPHORE_RUNNER_TOKEN_FILE) must persist across restarts.SEMAPHORE_RUNNER_API_URLin the example compose stack is not consumed by the current runner binary.