Skip to content

chore(docs): update PostgreSQL version requirements#1327

Open
ervcz wants to merge 1 commit intomainfrom
chore/document-postgresql-14-requirement
Open

chore(docs): update PostgreSQL version requirements#1327
ervcz wants to merge 1 commit intomainfrom
chore/document-postgresql-14-requirement

Conversation

@ervcz
Copy link
Copy Markdown
Collaborator

@ervcz ervcz commented Mar 11, 2026

chore(docs): document PostgreSQL 14+ as a requirement

The lib/pq driver was recently updated to v1.11.2 (#1300), which dropped support for PostgreSQL versions older than 14. This PR documents that breaking change across the project to ensure operators are aware before upgrading.

Changes:

  • CHANGELOG.md: Added a [4.0.0] section with a "Breaking Changes" entry documenting the PostgreSQL 14+ requirement.
  • README.md: Added a "Requirements" section listing PostgreSQL 14+ (17.x recommended).
  • charts/nebraska/README.md: Added an upgrade warning under the "Upgrade PostgreSQL" section for users running PostgreSQL 13 or older.

Testing done

Documentation-only change — no functional code modified.

  • Changelog entries added in the respective changelog/ directory (user-facing change, bug fix, security fix, update)

@ervcz ervcz requested a review from a team as a code owner March 11, 2026 09:56
CHANGELOG.md Outdated

### Breaking Changes

- **PostgreSQL 14+ is now a hard requirement:** The `lib/pq` driver has been updated to v1.11.2, which only supports PostgreSQL 14 and newer. Previously, PostgreSQL 17.x was the "tested and default" version, but older versions (e.g., PostgreSQL 13) may have still worked. With this update, **operators running PostgreSQL 13 or older must upgrade their database before upgrading Nebraska**. ([#1300](https://github.com/flatcar/nebraska/pull/1300))
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Good idea

@ervcz ervcz force-pushed the chore/document-postgresql-14-requirement branch from eb908cd to 1e9f214 Compare March 13, 2026 14:53
@ervcz ervcz requested a review from tormath1 March 13, 2026 14:54
- Update CHANGELOG to document PostgreSQL 14+ as a hard requirement
- Add PostgreSQL version requirements to main README
- Add upgrade warning to Helm chart README for PostgreSQL 13 users

Signed-off-by: Ervin Rácz <ervin.racz@protonmail.com>
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.

2 participants