Skip to content

Commit a700dc3

Browse files
chore: prepare for v4.9.0 release (#2247)
**Description** This PR preps for a release
1 parent 2a8b604 commit a700dc3

File tree

5 files changed

+201
-7
lines changed

5 files changed

+201
-7
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ Please explain the changes you made here.
55
**Checklist**
66

77
- [ ] Code compiles correctly and linting passes locally
8-
- [ ] For all _code_ changes, an entry added to the `CHANGELOG.md` file describing and linking to
9-
this PR
108
- [ ] Tests added for new functionality, or regression tests for bug fixes added as applicable
119

1210
**Instructions**

.github/workflows/ci-badger-tests.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ on:
66
- "**.md"
77
- docs/**
88
- images/**
9+
- contrib/**
910
branches:
1011
- main
1112
- release/v*

CHANGELOG.md

Lines changed: 155 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,139 @@ All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
66

7-
## [Unreleased]
7+
## [4.9.0] - 2025-12-15
8+
9+
**Fixed**
10+
11+
- fix(y): y.SafeCopy shall always return empty slice rather than nil (#2245)
12+
> **WARNING** SafeCopy now returns an empty slice rather than nil. For those using our `y` utility
13+
> package, this could be a breaking change. This has implications for empty slices stored in
14+
> badger, specifically, upon retrieval the value stored with the key will be equal to what was set
15+
> (an empty []byte). See #2067 for more details.
16+
- fix: test.sh error (#2225)
17+
- fix: typo of abandoned (#2222)
18+
19+
**Docs**
20+
21+
- add doc for encryption at rest (#2240)
22+
- move docs pages in the repo (#2232)
23+
24+
**Chores**
25+
26+
- chore(ci): restrict Dgraph test to core packages only (#2242)
27+
- chore: update README.md with correct links and badges (#2239)
28+
- chore: change renovate to maintain backwards compatible go version (#2236)
29+
- chore: configure renovate to leave go version as declared (#2235)
30+
- chore(deps): Update actions (major) (#2229)
31+
- chore(deps): Update actions/checkout action to v5 (#2221)
32+
- chore(deps): Update go minor and patch (#2218)
33+
- chore: update the trunk conf file (#2217)
34+
- chore(deps): Update dependency node to v22 (#2219)
35+
- chore(deps): Update go minor and patch (#2212)
36+
37+
**CI**
38+
39+
- move to GitHub Actions runners
40+
41+
**Full Changelog**: https://github.com/dgraph-io/badger/compare/v4.8.0...v4.8.1
42+
43+
## [4.8.0] - 2025-07-15
44+
45+
**Features**
46+
47+
- feat(stream): Update stream framework with new alternate keyToList function (#2211)
48+
49+
**Fixed**
50+
51+
- fix: crash loop on missing manifest tables (#2198)
52+
53+
**Chores**
54+
55+
- chore(deps): Update module golang.org/x/sys to v0.34.0 (#2210)
56+
- chore(deps): Update go minor and patch (#2208)
57+
- chore(deps): Update go minor and patch (#2204)
58+
- chore(deps): Update go minor and patch (#2202)
59+
- chore(deps): Update go minor and patch (#2200)
60+
- chore(deps): Update module golang.org/x/sys to v0.33.0 (#2195)
61+
- chore(deps): Update go minor and patch (#2189)
62+
- Compile with jemalloc v5.3.0 (#2191)
63+
64+
**CI**
65+
66+
- Update trunk.yml
67+
- move Trunk to action
68+
69+
**Docs**
70+
71+
- docs: add new badge (#2194)
72+
73+
**Full Changelog**: https://github.com/dgraph-io/badger/compare/v4.7.0...v4.8.0
74+
75+
## [4.7.0] - 2025-04-08
76+
77+
**Chores**
78+
79+
- chore(deps): remove dependency on github.com/pkg/errors (#2184)
80+
- chore(deps): Update go minor and patch (#2187)
81+
- chore(deps): Update go minor and patch (#2181)
82+
- chore(deps): Update module golang.org/x/sys to v0.31.0 (#2179)
83+
84+
**Fixed**
85+
86+
- fix broken badge (#2186)
87+
88+
**Docs**
89+
90+
- Update README.md
91+
- doc: add Blink Labs projects to the using Badger list (#2183)
92+
- doc: add FlowG to "Projects Using Badger" section of the README (#2180)
93+
94+
**Full Changelog**: https://github.com/dgraph-io/badger/compare/v4.6.0...v4.7.0
95+
96+
## [4.6.0] - 2025-02-26
97+
98+
**Chores**
899

9-
- chore(deps): Remove dependency on github.com/pkg/errors (#2184)
10100
- chore(deps): Migrate from OpenCensus to OpenTelemetry (#2169)
101+
- chore(deps): Update go minor and patch (#2177)
102+
- chore(deps): Update module github.com/spf13/cobra to v1.9.0 (#2174)
103+
- chore: add editor config
104+
- update .gitignore (#2176)
105+
106+
**Fixed**
107+
108+
- fix: remove accidentally uploaded binary `badger-darwin-arm64` (#2175)
109+
110+
**Full Changelog**: https://github.com/dgraph-io/badger/compare/v4.5.2...v4.6.0
111+
112+
## [4.5.2] - 2025-02-14
113+
114+
**Chores**
115+
116+
- chore(deps): Update go minor and patch (#2168)
117+
- chore(deps): bump minimum Go support to 1.22 (#2171)
118+
- chore: migrate docs to centralized docs repo (#2166)
119+
- chore: align repo conventions (#2158)
120+
- chore(deps): bump the patch group with 2 updates (#2156)
121+
- chore(deps): bump github.com/google/flatbuffers from 24.12.23+incompatible to 25.1.21+incompatible
122+
(#2153)
123+
- chore(deps): bump golangci/golangci-lint-action from 6.1.1 to 6.2.0 in the actions group (#2154)
124+
- Update renovate.json
125+
- Update trunk.yaml
126+
- enable Trivy
127+
128+
**Fixed**
129+
130+
- update docs link in error message (#2170)
131+
- Revert "Update badgerpb4.pb.go" (#2172)
132+
133+
**Docs**
134+
135+
- Update README.md
136+
- Added my project that uses Badger database (#2157)
137+
- Create SECURITY.md
138+
139+
**Full Changelog**: https://github.com/dgraph-io/badger/compare/v4.5.1...v4.5.2
11140

12141
## [4.5.1] - 2025-01-21
13142

@@ -947,7 +1076,30 @@ Bug fix:
9471076

9481077
- Fix an uint16 overflow when resizing key slice
9491078

950-
[Unreleased]: https://github.com/dgraph-io/badger/compare/v2.2007.2...HEAD
1079+
[4.9.0]: https://github.com/dgraph-io/badger/compare/v4.8.0...v4.9.0
1080+
[4.8.0]: https://github.com/dgraph-io/badger/compare/v4.7.0...v4.8.0
1081+
[4.7.0]: https://github.com/dgraph-io/badger/compare/v4.6.0...v4.7.0
1082+
[4.6.0]: https://github.com/dgraph-io/badger/compare/v4.5.2...v4.6.0
1083+
[4.5.2]: https://github.com/dgraph-io/badger/compare/v4.5.1...v4.5.2
1084+
[4.5.1]: https://github.com/dgraph-io/badger/compare/v4.5.0...v4.5.1
1085+
[4.5.0]: https://github.com/dgraph-io/badger/compare/v4.4.0...v4.5.0
1086+
[4.4.0]: https://github.com/dgraph-io/badger/compare/v4.3.1...v4.4.0
1087+
[4.3.1]: https://github.com/dgraph-io/badger/compare/v4.3.0...v4.3.1
1088+
[4.3.0]: https://github.com/dgraph-io/badger/compare/v4.2.0...v4.3.0
1089+
[4.2.0]: https://github.com/dgraph-io/badger/compare/v4.1.0...v4.2.0
1090+
[4.1.0]: https://github.com/dgraph-io/badger/compare/v4.0.1...v4.1.0
1091+
[4.0.1]: https://github.com/dgraph-io/badger/compare/v4.0.0...v4.0.1
1092+
[4.0.0]: https://github.com/dgraph-io/badger/compare/v3.2103.5...v4.0.0
1093+
[3.2103.5]: https://github.com/dgraph-io/badger/compare/v3.2103.4...v3.2103.5
1094+
[3.2103.4]: https://github.com/dgraph-io/badger/compare/v3.2103.3...v3.2103.4
1095+
[3.2103.3]: https://github.com/dgraph-io/badger/compare/v3.2103.2...v3.2103.3
1096+
[3.2103.2]: https://github.com/dgraph-io/badger/compare/v3.2103.1...v3.2103.2
1097+
[3.2103.1]: https://github.com/dgraph-io/badger/compare/v3.2103.0...v3.2103.1
1098+
[3.2103.0]: https://github.com/dgraph-io/badger/compare/v3.2011.1...v3.2103.0
1099+
[3.2011.1]: https://github.com/dgraph-io/badger/compare/v3.2011.0...v3.2011.1
1100+
[3.2011.0]: https://github.com/dgraph-io/badger/compare/v2.2007.4...v3.2011.0
1101+
[2.2007.4]: https://github.com/dgraph-io/badger/compare/v2.2007.3...v2.2007.4
1102+
[2.2007.3]: https://github.com/dgraph-io/badger/compare/v2.2007.2...v2.2007.3
9511103
[2.2007.2]: https://github.com/dgraph-io/badger/compare/v2.2007.1...v2.2007.2
9521104
[2.2007.1]: https://github.com/dgraph-io/badger/compare/v2.2007.0...v2.2007.1
9531105
[2.2007.0]: https://github.com/dgraph-io/badger/compare/v2.0.3...v2.2007.0

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@ well suited for new contributors.
3131

3232
## Setting up your development environment
3333

34-
Badger uses [`Go Modules`](https://github.com/golang/go/wiki/Modules) to manage dependencies. The
35-
version of Go should be **1.12** or above.
34+
- [Install Go 1.25.0 or above](https://golang.org/doc/install).
35+
- Install
36+
[trunk](https://docs.trunk.io/code-quality/overview/getting-started/install#install-the-launcher).
37+
Our CI uses trunk to lint and check code, having it installed locally will save you time.
3638

3739
### Fork the project
3840

contrib/RELEASE.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Badger Release Process
2+
3+
This document outlines the steps needed to build and push a new release of Badger.
4+
5+
1. Have a team member "at-the-ready" with github `writer` access (you'll need them to approve PRs).
6+
1. Create a new branch (prepare-for-release-vXX.X.X, for instance).
7+
1. Update dependencies in `go.mod` for Ristretto, if required.
8+
1. Update the CHANGELOG.md. Sonnet 4.5 does a great job of doing this. Example prompt:
9+
`I'm releasing vXX.X.X off the main branch, add a new entry for this release. Conform to the`
10+
`"Keep a Changelog" format, use past entries as a formatting guide. Run the trunk linter.`
11+
1. Validate the version does not have storage incompatibilities with the previous version. If so,
12+
add a warning to the CHANGELOG.md that export/import of data will need to be run as part of the
13+
upgrade process.
14+
1. Commit and push your changes. Create a PR and have a team member approve it.
15+
1. Once your "prepare for release branch" is merged into main, on the github
16+
[releases page](https://github.com/dgraph-io/badger/releases), create a new draft release.
17+
1. Start the deployment workflow from the
18+
[CD workflow page](https://github.com/dgraph-io/badger/actions/workflows/cd-badger.yml).
19+
20+
The CD workflow handles the building and copying of release artifacts to the releases area.
21+
22+
1. For all major and minor releases (non-patches), create a release branch. In order to easily
23+
backport fixes to the release branch, create a release branch from the tag head. For instance, if
24+
we're releasing v4.9.0, create a branch called `release/v4.9` from the tag head (ensure you're on
25+
the main branch from which you created the tag):
26+
27+
```sh
28+
git checkout main
29+
git pull origin main
30+
git checkout -b release/v4.9
31+
git push origin release/v4.9
32+
```
33+
34+
1. Splash the "go index" cache to ensure that the latest release is available to the public with:
35+
36+
```sh
37+
go list -m github.com/dgraph-io/[email protected]
38+
```
39+
40+
1. If needed, create a new announcement thread in the
41+
[Discussions](https://github.com/orgs/dgraph-io/discussions) forum for the release.

0 commit comments

Comments
 (0)