docs: community health files and complete verifier documentation#28
Merged
Conversation
Add LICENSE (MIT), CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, issue templates, and a PR template to satisfy the GitHub community profile checklist (currently at 37%).
Add SendGrid to the README verifiers table and USAGE.md verifier types section. Correct configure-route.md to say "Event Webhook" only; the verifier does not support Inbound Parse (no signature on those requests).
Add gitlab, oidc, json_field, query_param, and header_query_param to the README verifiers table and USAGE.md verifier types section. Add Google Chat and Azure Event Grid (AAD) setup sections to configure-route.md. Update the USAGE.md Supported Providers table and PROVIDER_TODO.md Already Implemented list to include all verifier types.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
Docker Images BuiltImages are available for testing: # gatekeeperd
docker pull ghcr.io/tight-line/gatekeeperd:pr-28-63f1347
# gatekeeper-relay
docker pull ghcr.io/tight-line/gatekeeper-relay:pr-28-63f1347docker-compose.ymlGATEKEEPERD_IMAGE=ghcr.io/tight-line/gatekeeperd:pr-28-63f1347 \
RELAY_IMAGE=ghcr.io/tight-line/gatekeeper-relay:pr-28-63f1347 \
docker-compose --profile relay upHelm (values override)image:
repository: ghcr.io/tight-line/gatekeeperd # or gatekeeper-relay
tag: "pr-28-63f1347"Images expire ~15 days after PR closes. |
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
Brings the repo up to a full GitHub community health score (currently 37%) and fills documentation gaps across all implemented verifier types.
Changes
LICENSE(MIT),CODE_OF_CONDUCT.md,CONTRIBUTING.md,SECURITY.md,.github/ISSUE_TEMPLATE/(bug + feature), and.github/pull_request_template.mdto satisfy the GitHub community profile checklistconfigure-route.mdheading and IP allowlist note that incorrectly mentioned Inbound Parse (not supported)gitlab,oidc,json_field,query_param,header_query_param) to the README verifiers table and USAGE.md verifier types sectionconfigure-route.mdPROVIDER_TODO.mdAlready Implemented list to cover all verifier typesTesting
Documentation-only changes. No code modified, no tests needed.
Checklist
make testpasses locallymake lintpasses locally