Skip to content
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

Jump to bottom

feat(CI): suppress generated files in PR diffs #389

Merged
merged 21 commits into from
Mar 13, 2024
Merged

feat(CI): suppress generated files in PR diffs #389

merged 21 commits into from
Mar 13, 2024

Conversation

jakedoublev
Copy link
Contributor

@jakedoublev jakedoublev commented Mar 13, 2024 •
edited
Loading

Closes #290

  1. Consumes GH tooling to suppress diffs of generated code & docs. The long-term solution is to move generated code into an external registry like Buf's (see existing issue) and docs to a GH Pages branch (related to existing release automation issue), but those automations can come later.
  2. Cleans up deprecated generated docs and ensures generation of docs cleans them going forward.

@jakedoublev
Copy link
Contributor Author

Screenshot 2024-03-13 at 2 38 15 PM

@jakedoublev jakedoublev force-pushed the feature/suppress-generated branch from ea482f0 to 620f819 Compare March 13, 2024 19:05
@jakedoublev jakedoublev marked this pull request as ready for review March 13, 2024 19:08
@jakedoublev jakedoublev requested a review from a team as a code owner March 13, 2024 19:08
@jakedoublev jakedoublev changed the title feat(CI): suppress generated files and rebuild in CI feat(CI): suppress generated files in PR diffs Mar 13, 2024
@jakedoublev jakedoublev added this pull request to the merge queue Mar 13, 2024
Merged via the queue into main with commit bcc04e0 Mar 13, 2024
10 checks passed
@jakedoublev jakedoublev deleted the feature/suppress-generated branch March 13, 2024 20:07
strantalis pushed a commit that referenced this pull request Mar 14, 2024
@jakedoublev @strantalis
feat(CI): suppress generated files in PR diffs (#389)
9bf0151 
* suppress generated code via .gitattributes

* add generate CI action to rebuild suppressed files

* add toolcheck

* bring in proto dependencies

* pin to golangci-lint 1.55 in generate workflow

* improve logs and remove toolcheck with dependencies installed

* test alteration of generated file

* remove generated grpc index.html docs

* remove more docs to test suppression

* remove comments from gencode to test suppression

* push generation after commit and improve logs

* add branch name to generate workflow

* add dummy proto to visualize suppressed diff

* .gitattributes update

* fix java generated code filepath

* denote the TODO to use groups instead of individuals in .gitattributes CODEOWNERship

* remove generate workflow in favor of using a github pages automation for docs and a schema registry for generated code during the hardening milestone work

* remove dummy proto

* make sure generation from protos cleans docs and regenerates

* clean codeowners
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@strantalis strantalis strantalis approved these changes

@dmihalcik-virtru dmihalcik-virtru Awaiting requested review from dmihalcik-virtru

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Suppress generated files in PR diffs
2 participants
@jakedoublev @strantalis