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

[Bug]: Hosted API docs are already for the new API and don't match with the latest go package version 0.31.0 #2625

Closed
Glup3 opened this issue Jul 4, 2024 · 6 comments · Fixed by #2627
Labels
bug An issue with the library

Comments

@Glup3
Copy link

Glup3 commented Jul 4, 2024

Testcontainers version

0.31.0

Using the latest Testcontainers version?

Yes

Host OS

MacOS

Host arch

ARM

Go version

1.22.4

Docker version

irrelevant

Docker info

irrelevant

What happened?

I have tried to implement the postgres module via the docs, but noticed they don't match with the latest pushed version (0.31.0). Will the package be updated soon? Should I wait for the new release or stick with 0.31.0, if so, are the older docs still available somewhere?

Relevant log output

No response

Additional information

Also asked on Slack

@Glup3 Glup3 added the bug An issue with the library label Jul 4, 2024
@mdelapenya
Copy link
Member

Indeed, that's an issue with our docs system, in which we do not support multiversion. It's unfortunate that the docs always show what's in main, even though the release has not been produced. We are planning to release really soon.

@mdelapenya
Copy link
Member

@Glup3 please check #2627 The rendered version of the site after those changes will be https://deploy-preview-2627--testcontainers-go.netlify.app/modules/azurite/#run-function

I'd appreciate your feedback 🙏

@Glup3
Copy link
Author

Glup3 commented Jul 5, 2024

Thanks for the quick response! Would it be feasible to have the old usage examples as another tab also in the docs? Otherwise you have to dig into the library code in order to make it run and I don't really like that as a newbie 😅

@mdelapenya
Copy link
Member

I'm afraid that would be more complex, as we replaced all the usages of the deprecated function with the new one.

@mdelapenya
Copy link
Member

A new release will be eventually out soon. So you'll simply use the new version with the current docs 😄

@mdelapenya
Copy link
Member

BTW you can find more about the versioning docs issue here: #511

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug An issue with the library
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants