Repository navigation
docs: refresh validation.md, CONTRIBUTING, and sample-event - #58
Merged
Merged
Conversation
- Update docs/spec/validation.md with all shipped validation rules (D001–D043, K001–K003, SEC001–SEC004, A001–A009, W001–W012). - Update CONTRIBUTING.md with newer packages (kubernetes, monitoring, plugin, instancer, ingress, notify, etc.), make targets (man, schemas), and develop-not-main convention. - Enrich examples/sample-event to cover all 10 core categories by adding reverse (crackme-101), osint (satellite-spot), hardware (serial-dump), ai (prompt-leak), and a deployable service archetype in jailbreak (pyjail-escape). - Regenerate derived files (challenges.csv, index.json, CTFd manifests, traefik dynamic.yml). - Update discover_test.go to verify discovery of all 10 challenges. - Update docs/BACKLOG.md tracking.
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
Closes #53.
This PR brings the documentation, contributing guides, and sample event fixture into complete alignment with everything shipped in the recent development cycles (Kubernetes deploy mode, observability/monitoring stack, doctor preflights, plugin architecture, and instancers):
docs/spec/validation.md:A007–A009rule definitions.mctf doctorpreflight checks (D001–D003,D010–D013,D020–D021,D030–D031,D040–D043) with descriptions and hard/warn severities.CONTRIBUTING.md:internal/kubernetes/,internal/monitoring/,internal/plugin/, and existing unstaged components (instancer,ingress,notify,solve,status,info,platform/ctfd).Maketargets reference table (make build,test,test-integration,lint,schemas,man,tidy,clean).develop-not-mainbranching and contribution convention.examples/sample-event/:reverse/crackme-101(static archetype)osint/satellite-spot(static archetype)hardware/serial-dump(static archetype)ai/prompt-leak(static archetype)jailbreak/pyjail-escape(service archetype, port 16000, internal_port 8000, non-root USER, healthcheck)challenges.csv,index.json, CTFd manifests, Traefikdynamic.yml).Tests & Validation:
TestDiscoverSampleEventininternal/challenge/discover_test.goto expect all 10 challenges.docs/BACKLOG.md.Verification
make build✅make test(go test ./...) ✅go test -race ./...✅make lint(go vet ./...+golangci-lint run ./...-> 0 issues) ✅./mctf -C examples/sample-event validate✅ (10 challenges validated, 0 errors)./mctf -C examples/sample-event generate --check✅ (derived files are up to date)scripts/validate-examples.py✅ (all 10 manifests pass JSON schema)scripts/validate-generated.py✅ (all 10 generated manifests pass JSON schema)scripts/validate-derived-sample.py✅