Skip to content

Commit e47266c

Browse files
committed
init changie
1 parent c7aaa62 commit e47266c

File tree

6 files changed

+118
-3
lines changed

6 files changed

+118
-3
lines changed

.changes/0.6.0.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
## v0.6.0
2+
* Bump go version to 1.23.6
3+
IMPROVEMENTS:
4+
* Updated dependencies:
5+
* `github.com/opencontainers/runc` v1.1.13 -> v1.2.6
6+
* `golang.org/x/crypto` v0.32.0 -> v0.36.0
7+
* `golang.org/x/net` v0.34.0 -> v0.38.0
8+
* `github.com/hashicorp/vault/sdk` v0.15.2 -> v0.17.0
9+
* `github.com/ory/dockertest/v3` v3.11.0 -> v3.12.0
10+
11+
## v0.5.0
12+
* Bump go version to 1.23.3
13+
IMPROVEMENTS:
14+
* Updated dependencies:
15+
* `github.com/hashicorp/vault/sdk` v0.14.0 -> v0.15.0
16+
* `github.com/ory/dockertest/v3` v3.10.0 -> v3.11.0
17+
18+
## v0.4.0
19+
* Bump go version to 1.22.6
20+
* Updated dependencies:
21+
* https://github.com/hashicorp/vault-plugin-database-redis/pull/72
22+
23+
## v0.3.0
24+
IMPROVEMENTS:
25+
* Updated dependencies:
26+
* https://github.com/hashicorp/vault-plugin-database-redis/pull/64
27+
28+
## v0.2.3
29+
IMPROVEMENTS:
30+
* Updated dependencies:
31+
* `github.com/hashicorp/go-hclog` v1.5.0 -> v1.6.2
32+
* `github.com/hashicorp/vault/sdk` v0.10.0 -> v0.10.2
33+
* `github.com/docker/docker` 23.0.4+incompatible -> 24.0.7+incompatible
34+
* `github.com/opencontainers/runc` 1.1.6 -> 1.1.12
35+
* `golang.org/x/crypto` 0.6.0 -> 0.17.0
36+
* `golang.org/x/net` 0.8.0 -> 0.17.0
37+
* `google.golang.org/grpc` 1.57.0 -> 1.57.1
38+
39+
40+
## v0.2.2
41+
IMPROVEMENTS:
42+
* Updated dependencies:
43+
* `github.com/hashicorp/vault/sdk` v0.9.0 -> v0.9.2
44+
* `github.com/mediocregopher/radix/v4` v4.1.2 -> v4.1.4
45+
* `github.com/ory/dockertest/v3` v3.9.1 -> v3.10.0
46+
47+
## v0.2.1
48+
* Dependency upgrades
49+
50+
## v0.2.0
51+
* No feature changes
52+
53+
## v0.1.0
54+
55+
* Initial release of the Redis database secrets engine for Vault

.changes/unreleased/.gitkeep

Whitespace-only changes.

.changie.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
changesDir: .changes
2+
unreleasedDir: unreleased
3+
changelogPath: CHANGELOG.md
4+
versionExt: md
5+
versionFormat: '## {{.Version}} ({{.Time.Format "January 02, 2006"}})'
6+
kindFormat: '{{.Kind}}:'
7+
changeFormat: '* {{.Body}} ([#{{.Custom.Issue}}](https://github.com/hashicorp/vault-plugin-database-redis/issues/{{.Custom.Issue}}))'
8+
custom:
9+
- key: Issue
10+
label: Issue/PR Number
11+
type: int
12+
minInt: 1
13+
kinds:
14+
- label: BREAKING CHANGES
15+
- label: NOTES
16+
- label: FEATURES
17+
- label: ENHANCEMENTS
18+
- label: BUG FIXES
19+
newlines:
20+
afterKind: 1
21+
beforeKind: 1
22+
endOfVersion: 2

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ How does this change affect the user experience (if at all)?
1313
- [ ] Add relevant docs to upstream Vault repository, or sufficient reasoning why docs won’t be added yet
1414
- [ ] Add output for any tests not ran in CI to the PR description (eg, acceptance tests)
1515
- [ ] Backwards compatible
16+
- [ ] Changelog entry added. See [Updating the Changelog](https://github.com/hashicorp/vault-plugin-database-redis/blob/main/README.md#updating-the-changelog).
1617

1718
## PCI review checklist
1819

CHANGELOG.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
## Unreleased
2-
31
## v0.6.0
42
* Bump go version to 1.23.6
53
IMPROVEMENTS:

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,4 +189,43 @@ on how to get started with Vault.
189189
5. `make teardown-env` will stop the Redis docker container with any resources generated alongside it such as network configs
190190

191191
When iterating, you can reload any local code changes with `make configure` as many times as desired to test the latest
192-
modifications via the Vault CLI or API.
192+
modifications via the Vault CLI or API.
193+
194+
## Updating the Changelog
195+
196+
All pull requests that introduce a user-facing change must include a changelog
197+
entry. We use the [changie](https://changie.dev/) tool to manage these entries
198+
and automate the release process.
199+
200+
---
201+
### 1. Installing Changie
202+
203+
You only need to do this once. If you don't have `changie` installed, choose one of the options below.
204+
205+
* **Homebrew** (macOS):
206+
```shell
207+
brew install changie
208+
```
209+
* **Go Install**:
210+
```shell
211+
go install github.com/miniscruff/changie@latest
212+
```
213+
* **Other Methods**:
214+
See the [official changie installation guide](https://changie.dev/guide/installation/) for other options, including pre-compiled binaries.
215+
216+
---
217+
### 2. Creating an Entry
218+
219+
Once your code changes are complete, create the changelog entry:
220+
221+
1. **Run the command** in your terminal:
222+
```shell
223+
changie new
224+
```
225+
2. **Follow the prompts.** An interactive prompt will ask you to select the
226+
kind of change (e.g., `BREAKING CHANGES`, `NOTES`, `FEATURES`) and write a concise description of
227+
what you changed.
228+
229+
3. **Commit the new file.** After you're done, `changie` will create a new
230+
YAML file in the `.changie/unreleased` directory. Commit this file along with your other
231+
code changes before submitting your pull request.

0 commit comments

Comments
 (0)