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.

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

chore: mark more files as generated #11321

Merged
merged 1 commit into from
Jul 9, 2023

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Jul 9, 2023

Motivation

There are several more files/folders that are generated (and not .gitignore'd)

  • This makes diffs etc easier to read by collapsing these files by default

c.f. GitHub Docs

Modifications

  • Java SDK docs are generated, similar to Python

  • CRDs are generated

  • quick start manifests are generated from the other manifests

  • top-level JSONSchema and OpenAPI spec/Swagger are generated from other files

  • did not include some auto-generated Go files as GitHub is already picking up those by default

    • i.e. *.pb.go, *.pb.gw.go, etc
    • similar for go-to-protobuf detection

Verification

Notes for Reviewers

I do believe there are more generated files, but I wasn't as sure about those so did not include them. Can include them with confirmations. For instance,

  • the entirety of pkg/client/, which I believe is generated here
  • some swagger files here and there
  • docs/fields.md and docs/cli/argo.md as those are user-facing docs, so potentially(??) good to code review and remind that some comments are user-facing etc. That's just my opinion so far though, could change / be changed

- several more files/folders that are generated (and _not_ `.gitignore`'d)

- Java SDK docs are auto-generated, similar to Python
- CRDs are auto-generated
- quick start manifests are auto-generated from the other manifests
- top-level JSONSchema and OpenAPI spec/Swagger are auto-generated from other files

- did not include some auto-generated Go files as GitHub is already picking up those by default
  - i.e. `*.pb.go`, `*.pb.gw.go`, etc

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 changed the title github: mark more files as generated chore: mark more files as generated Jul 9, 2023
@terrytangyuan terrytangyuan enabled auto-merge (squash) July 9, 2023 23:18
@terrytangyuan terrytangyuan merged commit 9264f76 into argoproj:master Jul 9, 2023
26 of 27 checks passed
@agilgur5 agilgur5 deleted the github-mark-generated branch July 9, 2023 23:41
@agilgur5
Copy link
Member Author

The default diff in #11325 does look decently cleaner now! 🙂

Also this seems to be testable in-PR. Prior to rebasing with master (that had this merged PR), it still loaded some of the generated diffs, then after I rebased, they got collapsed as generated files.

@agilgur5 agilgur5 added the area/build Build or GithubAction/CI issues label Aug 27, 2023
@agilgur5 agilgur5 added the area/contributing Contributing docs, ownership, etc. Also devtools like devcontainer and Nix label Feb 13, 2024
@agilgur5
Copy link
Member Author

agilgur5 commented Mar 9, 2024

  • the entirety of pkg/client/, which I believe is generated here

Wrote a follow-up to this in #12773

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build Build or GithubAction/CI issues area/contributing Contributing docs, ownership, etc. Also devtools like devcontainer and Nix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants