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

build: remove swagger #124674

Merged
merged 1 commit into from
May 24, 2024
Merged

build: remove swagger #124674

merged 1 commit into from
May 24, 2024

Conversation

rickystewart
Copy link
Collaborator

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

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 rickystewart requested a review from rail May 24, 2024 18:55
@rickystewart rickystewart requested review from a team as code owners May 24, 2024 18:55
@rickystewart rickystewart requested review from kyle-a-wong and removed request for a team May 24, 2024 18:55
Copy link

blathers-crl bot commented May 24, 2024

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.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Member

@rail rail left a comment

Choose a reason for hiding this comment

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

🗡️ 🔥

@rickystewart
Copy link
Collaborator Author

bors r=rail

@craig craig bot merged commit 670640b into cockroachdb:master May 24, 2024
21 of 22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants