chore: clean up the repository root - #84
Merged
Merged
Conversation
The three event rows it inserted are already seeded by src/main/resources/data-local.sql (INSERT IGNORE INTO events), which is what the local and playwright-test profiles actually load. Nothing in the build, application config, workflows, or Playwright suite referenced test-data.sql.
HELP.md (Spring Initializr boilerplate) and TEST-ANALYSIS.md (a one-off test triage report) are reference material, not entry points, so they move out of the root listing. README.md, CHANGELOG.md, CONFIG.md, CLAUDE.md and LICENSE stay at root: the first three are linked from the README and are the docs external links land on, and Claude Code reads CLAUDE.md at root. The 18 @disabled annotations in src/test that point readers at TEST-ANALYSIS.md now say docs/TEST-ANALYSIS.md.
The only stray helper script at the root. Invocations in README.md and CLAUDE.md now say ./scripts/run.sh. The script gains a shebang, set -euo pipefail, an executable bit (it was mode 644, so the documented ./run.sh would have failed with permission denied), and a cd to the repo root so the relative ./gradlew and build/libs paths resolve from any cwd.
.vscode/tasks.json is tracked and shared, but a blanket .vscode/ rule claimed the opposite; replaced with .vscode/* plus a !.vscode/tasks.json negation so the tracked file matches the rules. Also added .idea/ and *.iml so IntelliJ state cannot get committed by accident.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR cleans up the repository root to align with the upstream SpringUserFramework repo’s layout, removing vestigial tracked files and moving auxiliary documentation/scripts into more appropriate locations while updating references.
Changes:
- Removed obsolete root-level artifacts (e.g.,
test-data.sql) and updated disabled-test pointers to the moved test analysis doc. - Moved/added auxiliary docs under
docs/and updated root references (tests, README). - Replaced the root
run.shwithscripts/run.sh, updating documentation accordingly, and refined.gitignoreto match tracked VS Code config and ignore IDE state.
Reviewed changes
Copilot reviewed 20 out of 23 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| test-data.sql | Deleted obsolete SQL seed file from repo root. |
| src/test/java/com/digitalsanctuary/spring/user/security/EmailVerificationEdgeCaseTest.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/security/AuditLoggingIntegrationTest.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/oauth2/GoogleOAuth2IntegrationTest.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/integration/SecurityConfigurationTest.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/integration/AuthenticationIntegrationTest.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/concurrent/AdminUserManagementTest.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/api/UserRegistrationEdgeCaseTest.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/api/UserRegistrationCoreTest.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/api/UserRegistrationComprehensiveTest.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/api/UserApiTest.java | Updated multiple @Disabled references to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/api/PasswordResetCompletionTest.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/api/PasswordResetApiTestSimplified.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/api/PasswordResetApiTest.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/api/AuthenticatedUserApiTestSimplified.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| src/test/java/com/digitalsanctuary/spring/user/api/ApiSecurityTest.java | Updated @Disabled reference to docs/TEST-ANALYSIS.md. |
| scripts/run.sh | Added a new run script under scripts/ for building/running with JDWP. |
| run.sh | Removed the old root-level run script. |
| README.md | Updated documented run script path to ./scripts/run.sh. |
| docs/TEST-ANALYSIS.md | Added/moved test analysis document under docs/. |
| docs/HELP.md | Added/moved Spring Initializr boilerplate help under docs/. |
| CLAUDE.md | Updated documented run script path to ./scripts/run.sh. |
| .gitignore | Adjusted .vscode ignore rules to keep tracked tasks.json; added IntelliJ ignores. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| cd "$(dirname "$0")/.." | ||
|
|
||
| ./gradlew bootJar | ||
| java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:6332 -jar build/libs/ds-spring-user-framework-demo-1.0.1-SNAPSHOT.jar --spring.profiles.active=local |
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.
Mirrors the root-directory cleanup just done on the SpringUserFramework library repo. Same tiers, same keep-at-root rules.
Tier 1 — local junk (no commit; untracked/ignored only)
bin/(gitignored, never regenerated by Gradle).config/directory.No
.gitignoreadditions were needed:bin/,build/,.gradle/,playwright/node_modules/,playwright/reports/and the AI-dump filenames (repomix-output.txt,project_concatenated.txt) are already covered, and the app logs to/opt/app/logs, not into the repo.Tier 2 — vestigial tracked file
test-data.sql. Its three event rows are already seeded bysrc/main/resources/data-local.sql, which is what thelocalandplaywright-testprofiles actually load. Nothing in the build, application config, workflows, or the Playwright suite referenced it.Tier 3 — auxiliary docs moved to
docs/HELP.md→docs/HELP.md(Spring Initializr boilerplate; its links still point at the Spring Boot 2.4.2 reference docs while this app is on Boot 4.1.0).TEST-ANALYSIS.md→docs/TEST-ANALYSIS.md, and the 18@Disabledannotations insrc/testthat point readers at it now saydocs/TEST-ANALYSIS.md.Kept at root:
README.md,CHANGELOG.md,LICENSE,CLAUDE.md(Claude Code reads it at root), andCONFIG.md.CONFIG.mdis the judgment call. It is this repo's setup reference, linked from the README, and GitHub does not redirect moved files — the library repo kept its ownCONFIG.mdandMIGRATION.mdat root for exactly that reason, so this mirrors it. Easy to move later if you'd rather.Tier 4 — stray script moved to
scripts/run.sh→scripts/run.sh;README.mdandCLAUDE.mdnow say./scripts/run.sh.set -euo pipefail, an executable bit (it was mode 644, so the documented./run.shwould have failed with permission denied), and acdto the repo root so the relative./gradlewandbuild/libspaths resolve from any cwd.Not moved, per the framework repo's
RELEASE-TESTING.mdrunbook which references these paths cross-repo, or because a workflow depends on the current path:compose.yaml,compose.dev.yaml,docker-compose-keycloak.yml,Dockerfile,keycloak.env,mailserver.env,keycloak/,playwright/, the Gradle wrapper,build.gradle,settings.gradle,mise.toml.Tier 5 — IDE state
No
.idea/in this repo..vscode/tasks.jsonstays tracked, as decided..gitignorehad a blanket.vscode/rule that contradicted the trackedtasks.json; replaced with.vscode/*plus a!.vscode/tasks.jsonnegation so the rules match reality. Added.idea/and*.imlso IntelliJ state cannot land by accident.Validation
./gradlew test— BUILD SUCCESSFUL, 301 tests, 0 failures, 0 errors (182 pre-existing@Disabled, 119 passing). Same counts asmain.CHANGELOG.mdhistorical prose left as written.playwright/, nothing referenced byplaywright/playwright.config.ts, and nothing in the app's runtime resources changed. CI runs the full E2E suite on this PR anyway.