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

feat: add Postgres module #945

Merged
merged 20 commits into from Mar 23, 2023

Conversation

mdelapenya
Copy link
Collaborator

@mdelapenya mdelapenya commented Mar 21, 2023

What does this PR do?

This PR converts the existing example into a real Go module. You can find the implementation details in the rendered URL for the docs here:

https://deploy-preview-945--testcontainers-go.netlify.app/modules/postgres/

The steps to convert an example into a module are:

  • rename module path at go.mod
  • move the examples/$1 dir to modules/$1
  • move the $1 dependabot config from the examples section to the modules one (bottom)
  • move the mkdocs.yml entry for the module from examples to modules
  • update the GH workflow (names and paths)
  • expose types and functions in the example module
  • extend the docs to describe the new API of the module

Why is it important?

Add more modules, being Postgres one of the most used Docker images out there.

@mdelapenya mdelapenya requested a review from a team as a code owner March 21, 2023 10:22
@mdelapenya mdelapenya added the enhancement New feature or request label Mar 21, 2023
@mdelapenya mdelapenya self-assigned this Mar 21, 2023
@netlify
Copy link

netlify bot commented Mar 21, 2023

Deploy Preview for testcontainers-go ready!

Name Link
🔨 Latest commit 6705bde
🔍 Latest deploy log https://app.netlify.com/sites/testcontainers-go/deploys/641bfd4fc0d298000783c1b1
😎 Deploy Preview https://deploy-preview-945--testcontainers-go.netlify.app/modules/postgres
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

docs/modules/postgres.md Show resolved Hide resolved
modules/postgres/postgres.go Outdated Show resolved Hide resolved
modules/postgres/postgres.go Outdated Show resolved Hide resolved
@sonarcloud
Copy link

sonarcloud bot commented Mar 23, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
11.7% 11.7% Duplication

@mdelapenya mdelapenya merged commit e843b72 into testcontainers:main Mar 23, 2023
49 checks passed
@mdelapenya mdelapenya deleted the postgres-go-module branch March 24, 2023 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants