docs: add AGENTS.md agent guide for the plugin monorepo#1227
Merged
Conversation
Add an AGENTS.md tailored to this multi-module Grails Spring Security plugin repository, adapted from the grails-core AGENTS.md. It documents the build/test commands (the gradle-bootstrap step, single-module and single-test invocations, publishToMavenLocal, and the RAT license audit), the module/directory map from settings.gradle, the core plugin layout, Spock testing with the functional-test TESTCONFIG matrix, CI gates, branch structure, PR guidelines, and pointers to SECURITY.md and THREAT_MODEL.md. Carries the Apache license header so it passes `./gradlew rat`. Assisted-by: claude-code:claude-4.8-opus
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.
What
Adds an
AGENTS.mdto the repository root - a guide for AI coding agents (and human contributors) working in this multi-module Grails Spring Security plugin monorepo.Why
The repository had no
AGENTS.md. This adapts the grails-coreAGENTS.mdand customizes it for this plugin repository, so agents understand the build, module layout, and conventions specific tograils-spring-securityrather than treating it as a Grails application.Contents
gradle-bootstrapstep,./gradlew build [-PskipTests], single-module (:core-plugin:build) and single-test (--tests) invocations,publishToMavenLocal, and the RAT audit (./gradlew rat).jakarta.*overjavax.*,@GrailsCompileStatic, Apache license headers (RAT-enforced), no wildcard imports, andgrails.plugin.springsecurity.*as the authoritative configuration namespace.settings.gradle(core, acl, cas, ldap, oauth2, rest + token-storage backends, ui, compat, docs, examples).TESTCONFIGmatrix.gradle.yml,rat.yml), branch structure, PR guidelines, and pointers toSECURITY.md/THREAT_MODEL.md.Notes
SECURITY.mdalready exists on8.0.xand is more detailed and repo-tailored than grails-core's minimal version (it referencesTHREAT_MODEL.md, supported versions, and scope). This PR intentionally leaves it unchanged and adds onlyAGENTS.md../gradlew ratlocally.Verification
./gradlew rat- BUILD SUCCESSFUL