docs: restore developer guides and document recent validation changes#4010
Draft
cursor[bot] wants to merge 1 commit into
Draft
docs: restore developer guides and document recent validation changes#4010cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
Conversation
Replace the broken semaphore-docs submodule with in-repo documentation under docs/developer/. Restores guides for runner auth/JWT, executors, Docker images, workflows, and the HA cluster API from prior doc automation work. - Sync api-docs.yml with runner status/started_at, template jwt_params, workflow stop endpoint; remove stale runner private_key field - Document runner liveness timeouts in deployment/compose README - Add job/helper image table to deployment/docker README - Fix duplicate SQLite section in compose docs - Add input-validation.md for playbook path, git URL, branch override, roles, and access key update checks (develop commits since June 2026) - Link developer docs from README and CONTRIBUTING; drop --recursive clone hint 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
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.
Summary
Restores in-repo developer documentation and syncs deployment/API docs with recent runner and workflow changes on
develop.Docs added/updated
docs/developer/README.mddocs/developer/runner-auth-and-jwt.mddocs/developer/runner-executors.mddocs/developer/docker-images.mddocs/developer/workflows.mddocs/developer/ha-cluster-dashboard.mddocs/developer/input-validation.mddeployment/compose/README.mddeployment/docker/README.mdapi-docs.ymlstatus/started_at, templatejwt_params, workflow stop endpoint; remove stale runnerprivate_keyREADME.md,CONTRIBUTING.md--recursiveclone (submodule removed)Codepaths covered
api/runners.go,db/Runner.go,services/runners/,util/config.go(runners.*)jwt_params,/.well-known/jwks.jsonservices/runners/,deployment/docker/db/playbook_path.go,db/git_url.go,services/tasks/local_executor.go(resolveGitBranch),db/Role.go,api/projects/keys.goKnowledge gaps addressed
semaphore-docssubmodule replaced with maintained in-repo developer notesdevelop(playbook path traversal, git option injection, branch override gate, custom role slug shadowing, access key IDOR) explained for contributors