[TC-003] - Add PrivateConst to gitignore#3676
Open
kdeakinstructure wants to merge 1 commit intomasterfrom
Open
[TC-003] - Add PrivateConst to gitignore#3676kdeakinstructure wants to merge 1 commit intomasterfrom
kdeakinstructure wants to merge 1 commit intomasterfrom
Conversation
…onal push of hardcoded credentials.
Contributor
🧪 Unit Test Results📊 Summary
Last updated: Mon, 04 May 2026 13:46:29 GMT |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Summary
This PR adds src/main/java/com/instructure/dataseeding/util/PrivateConst.kt to the .gitignore for the automation/dataseedingapi module — a straightforward and correct security hygiene change.
Findings:
- No setup documentation —
automation/dataseedingapi/readme.mdhas no mention ofPrivateConst.ktor how developers should obtain/configure it. New contributors won't know this file is required for the build (compileKotlindepends onaddPrivateData, which copies it from the private data vault), and they'll get a cryptic build failure without guidance.
What looks good:
- The file is confirmed not currently tracked in git, so the
.gitignoreaddition alone is sufficient (nogit rm --cachedneeded). - Using
src/main/java/...is intentional and matches wherePrivateData.merge(project, "dataseeding")copies the file from the private vault — consistent with the existingsrc/main/java/com/instructure/soseedygitignore pattern. - Protecting credentials/private constants from accidental commits is the right call, especially given this module builds against live Canvas API endpoints in CI.
The one suggestion worth addressing is adding a brief note to readme.md explaining that the build requires private data setup (pointing to the vault setup process), so developers hitting the PrivateData task failure know where to look.
Contributor
📊 Code Coverage Reportℹ️ Student
ℹ️ Teacher
ℹ️ Pandautils
|
hermannakos
approved these changes
May 5, 2026
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
2 participants
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.
Put dataseeding PrivateConst file into gitignore to prevent unintentional push of hardcoded credentials.