Skip to content

Commit

Permalink
docs: make the docs rain
Browse files Browse the repository at this point in the history
  • Loading branch information
sheldonhull committed Sep 5, 2023
1 parent f4ce3c6 commit ee88173
Show file tree
Hide file tree
Showing 12 changed files with 52 additions and 22 deletions.
2 changes: 1 addition & 1 deletion .aqua/aqua.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ registries:
packages:
- name: miniscruff/changie@v1.12.0
tags: ['release']
- name: golang/go@go1.20.3
- name: golang/go@go1.21.0
tags: ['first', 'release', 'test', 'scan', 'lint']
- name: direnv/direnv@v2.32.2
- name: magefile/mage@v1.14.0
Expand Down
3 changes: 0 additions & 3 deletions .changes/unreleased/⬆️ Dependencies-20230817-161010.yaml

This file was deleted.

3 changes: 0 additions & 3 deletions .changes/unreleased/🔨 Refactor-20230902-001843.yaml

This file was deleted.

4 changes: 0 additions & 4 deletions .changes/unreleased/🤖 CI & Build-20230902-001908.yaml

This file was deleted.

22 changes: 22 additions & 0 deletions .changes/v1.2.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## v1.2.1 - 2023-09-05

### 📘 Documentation

- Include detail on providing `tld` in the configuration, allowing `eu` and other TLDs to be used.
- Mention `tilt up` in the initial setup config as viable option.

### 🤖 CI & Build

- Improve mage tasks with secret setup and tear down for better development support and troubleshooting.
- Bump go version in release pipeline to use `1.21` as can include standard library security improvements.
- Remove failing error condition on `mage job:rebuild` to better allow default setup without running local builds, such as just using the published docker image.
This supports easier demo/test usage by support.

### 🔨 Refactor

- Improve logging with error wrapping and remove deprecated Go `ioutil` usage.

### ⬆️ Dependencies

- Bump tooling such as changie, release, trunk, more security scanners.
- Other dependency bumps such as `golang.org/x/net`.
8 changes: 4 additions & 4 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
name: lint
on:
# Run CI against all pushes (direct commits, also merged PRs), Pull Requests
push:
branches:
- main
- stable-*
# push:
# branches:
# - main
# - stable-*
pull_request:
# Run CI once per day (at 06:00 UTC)
# This ensures that even if there haven't been commits that we are still testing against latest version of ansible-test for each ansible-base version
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ jobs:
- name: Setup Golang with cache
uses: magnetikonline/action-golang-cache@797f193169d3c8ba6f60d90f50ecdadd2583fbd8 # tag=v3
with:
go-version-file: go.mod
go-version: ~1.21
# with:
# go-version-file: go.mod

- uses: aquaproj/aqua-installer@61e2563dfe7674cbf74fe6ec212e444198a3bb00 # tag=v2.0.2
with:
Expand Down
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
and is generated by [Changie](https://github.com/miniscruff/changie).

## v1.2.1 - 2023-09-05

### 🤖 CI & Build

- Improve mage tasks with secret setup and tear down for better development support and troubleshooting.

- Bump go version in release pipeline to use `1.21` as can include standard library security improvements.

### 🔨 Refactor

- Improve logging with error wrapping and remove deprecated Go `ioutil` usage.

### ⬆️ Dependencies

- Bump changie installation, goreleaser.

## v1.2.0 - 2023-04-27

### 🤖 CI & Build
Expand Down
4 changes: 2 additions & 2 deletions charts/dsv-injector/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |
NAMESPACE='dsv'
CREDENTIALS_JSON_FILE='.cache/credentials.json' # replace with your credentials file
IMAGE_REPOSITORY='docker.io/delineaxpm/dsv-k8s'
IMAGE_TAG='v1.2.0' # use latest for test, but pin to a specific version for production
IMAGE_TAG='v1.2.1' # use latest for test, but pin to a specific version for production
helm install \
--namespace $NAMESPACE \
Expand All @@ -29,7 +29,7 @@ keywords:
- secrets
- vault
type: application
version: v1.2.0
version: v1.2.1
appVersion: latest
maintainers:
- name: Sheldon Hull
Expand Down
2 changes: 1 addition & 1 deletion charts/dsv-injector/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ image:
# -- Overrides the image tag whose default is the chart appVersion.
# Local Testing: Use `latest`.
# @default -- the current app version/chart version
tag: v1.2.0
tag: v1.2.1
# -- Entrypoint is the path to the binary. Since the container image could contain multiple binaries, this makes sure it's correctly mapped to the binary.
entrypoint: /app/dsv-injector

Expand Down
4 changes: 2 additions & 2 deletions charts/dsv-syncer/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |
```shell
NAMESPACE='dsv'
IMAGE_REPOSITORY='docker.io/delineaxpm/dsv-k8s'
IMAGE_TAG='v1.2.0' # use latest for test, but pin to a specific version for production
IMAGE_TAG='v1.2.1' # use latest for test, but pin to a specific version for production
helm install \
--namespace $NAMESPACE \
Expand All @@ -26,7 +26,7 @@ keywords:
- secrets
- vault
type: application
version: v1.2.0
version: v1.2.1
appVersion: latest
maintainers:
- name: Sheldon Hull
Expand Down
2 changes: 1 addition & 1 deletion charts/dsv-syncer/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ image:
# -- Overrides the image tag whose default is the chart appVersion.
# Local Testing: Use `latest`.
# @default -- the current app version/chart version
tag: v1.2.0
tag: v1.2.1
# -- Entrypoint is the path to the binary. Since the container image could contain multiple binaries, this makes sure it's correctly mapped to the binary.
entrypoint: /app/dsv-syncer

Expand Down

0 comments on commit ee88173

Please sign in to comment.