Skip to content

Add a check to the frontend to make sure that generated files are tracked or fails the build #1761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 10, 2025
Merged

Add a check to the frontend to make sure that generated files are tracked or fails the build #1761

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6862c4d
Add a check to make sure that generated files are tracked or fails th…
peternied Aug 13, 2025
96220e0
Fix up change tracking to use repo root instead of project root
peternied Aug 13, 2025
0a12141
Merge remote-tracking branch 'origin/main' into generated-files-are-t…
peternied Aug 13, 2025
2e86afe
Add resolution message
peternied Aug 26, 2025
70f1989
Merge remote-tracking branch 'origin/main' into generated-files-are-t…
peternied Aug 26, 2025
3da318d
Merge branch 'main' into generated-files-are-tracked
peternied Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions frontend/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,30 @@ tasks.register('lintFrontend', NpmTask) {
inputs.files fileTree(dir: '.', include: buildInputs, exclude: buildExclusions)
}

tasks.register('checkGeneratedFilesTracked', Exec) {
dependsOn 'buildFrontend'
group = 'check'
description = 'Verifies there are no untracked files in src/generated directory'
workingDir = rootProject.rootDir

standardOutput = System.out
errorOutput = System.err

commandLine 'bash', '-c', '''
changed=$(git diff --name-only -- frontend/src/generated/)
untracked=$(git ls-files --others --exclude-standard -- frontend/src/generated/)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Script will check for diff and untracked files, which is good. How will we handle cases where new generated files are added ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the are part of a commit on the branch they will not fail in either of these checks. The nature of the problem is that there were api changes and they didn't got through code review but instead were automatically picked up during the auto-generation process.

if [ -n "$changed$untracked" ]; then
echo "Error: Unstaged or untracked files under frontend/src/generated/:"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we modify the error message to be something like "Please commit the following generated files:..."

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated response to include resolution message

> Task :frontend:checkGeneratedFilesTracked FAILED
Error: Unstaged or untracked files under frontend/src/generated/:
frontend/src/generated/api/types.gen.ts
Please run ./gradlew frontend:generateBackendClient and commit the updated files

[ -n "$changed" ] && echo "$changed"
[ -n "$untracked" ] && echo "$untracked"
echo "Please run ./gradlew frontend:generateBackendClient and commit the updated files"
exit 1
else
echo "OK: No unstaged or untracked files under frontend/src/generated/"
fi
'''
}

tasks.register('cleanFrontend', Delete) {
delete buildOutputs
}
Expand Down Expand Up @@ -104,4 +128,5 @@ The following is a list of npm commands to execute:

assemble.dependsOn 'buildFrontend'
check.dependsOn 'lintFrontend'
check.dependsOn 'checkGeneratedFilesTracked'
clean.dependsOn 'cleanFrontend'