build: remove generated swagger documentation #105291
Merged
Conversation
This file contains 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
This documentation hasn't been generated for about a year since we upgraded to Go 1.19. I haven't been able to find an owner for this stuff and no one seems to be able to confirm that this documentation is even used for anything. I think it's very confusing for there to appear to be generated documentation that in fact isn't generated at all and which is already stale and not kept up-to-date with the code, so I think the best option for us is to delete it. *If* this is important, then someone will notice it's missing, and hopefully that will motivate someone to own this. Epic: none Release note: None
|
It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR? 🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf. |
|
This change is |
rail
approved these changes
Jun 21, 2023
|
bors r=rail |
|
Build failed (retrying...): |
|
Build failed (retrying...): |
|
Build succeeded: |
rickystewart
added a commit
to rickystewart/cockroach
that referenced
this pull request
May 24, 2024
We stopped generating the Swagger documentation 2 years ago in cockroachdb#86049 to allow us to upgrade to Go 1.19. A year later, in cockroachdb#105291, we then deleted the stale tree. To date no one has complained or even noticed this documentation missing, we've moved on to Go 1.22, and we've had 2 years of releases. Time to just remove support for Swagger altogether, including the build dependency and the `go:swagger` directives. I kept the "structured" documentation comments. It may or may not be out-of-date, but it doesn't seem to be hurting anyone. Epic: none Release note: None
rickystewart
added a commit
to rickystewart/cockroach
that referenced
this pull request
May 24, 2024
We stopped generating the Swagger documentation 2 years ago in cockroachdb#86049 to allow us to upgrade to Go 1.19. A year later, in cockroachdb#105291, we then deleted the stale tree. To date no one has complained or even noticed this documentation missing, we've moved on to Go 1.22, and we've had 2 years of releases. Time to just remove support for Swagger altogether, including the build dependency and the `go:swagger` directives. I kept the "structured" documentation comments. It may or may not be out-of-date, but it doesn't seem to be hurting anyone. Epic: none Release note: None
craig bot
pushed a commit
that referenced
this pull request
May 24, 2024
124674: build: remove `swagger` r=rail a=rickystewart We stopped generating the Swagger documentation 2 years ago in #86049 to allow us to upgrade to Go 1.19. A year later, in #105291, we then deleted the stale tree. To date no one has complained or even noticed this documentation missing, we've moved on to Go 1.22, and we've had 2 years of releases. Time to just remove support for Swagger altogether, including the build dependency and the `go:swagger` directives. I kept the "structured" documentation comments. It may or may not be out-of-date, but it doesn't seem to be hurting anyone. Epic: none Release note: None Co-authored-by: Ricky Stewart <ricky@cockroachlabs.com>
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.
This documentation hasn't been generated for about a year since we upgraded to Go 1.19. I haven't been able to find an owner for this stuff and no one seems to be able to confirm that this documentation is even used for anything. I think it's very confusing for there to appear to be generated documentation that in fact isn't generated at all and which is already stale and not kept up-to-date with the code, so I think the best option for us is to delete it. If this is important, then someone will notice it's missing, and hopefully that will motivate someone to own this.
Epic: none
Release note: None