Skip to content

Commit

Permalink
Release ngrok-operator-0.13.3 helm-0.16.0 (#505)
Browse files Browse the repository at this point in the history
<!-- Thank you for contributing! Please make sure that your code changes
are covered with tests. In case of new features or big changes remember
to adjust the documentation.

In case of an existing issue, reference it using one of the following:

closes: #ISSUE
related: #ISSUE

How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->

## What
*Describe what the change is solving*

Enable release workflows for ngrok/ngrok-operator

Update versions

make helm-update-snapshots

Update releaseing.md guide

## How
*Describe the solution*

## Breaking Changes
*Are there any breaking changes in this PR?*
  • Loading branch information
hjkatz authored Nov 13, 2024
2 parents 186c79c + 7c40db3 commit d3feb24
Show file tree
Hide file tree
Showing 14 changed files with 75 additions and 27 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/helm_release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
contents: read
pull-requests: read
# TODO(operator-rename): Change this to ngrok/ngrok-operator when we are ready to release the helm chart
if: github.repository == 'ngrok/kubernetes-ingress-controller'
if: github.repository == 'ngrok/ngrok-operator'
steps:
- name: Checkout repo
uses: actions/checkout@v3
Expand All @@ -39,7 +39,7 @@ jobs:
needs: [changes]
# TODO(operator-rename): Change this to ngrok/ngrok-operator when we are ready to release the helm chart
if: |
(github.repository == 'ngrok/kubernetes-ingress-controller') &&
(github.repository == 'ngrok/ngrok-operator') &&
(needs.changes.outputs.charts == 'true')
steps:
- name: Checkout repo
Expand Down
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 0.13.3
**Full Changelog**: https://github.com/ngrok/ngrok-operator/compare/ngrok-operator-0.13.1...ngrok-operator-0.13.3

### Added

- Add support for 1-click demo mode by @hjkatz in [#503](https://github.com/ngrok/ngrok-operator/pull/503)
- Enable automatic Helm releases for `ngrok/ngrok-operator` in `.github/workflows` by @hjkatz in (this PR)

### Fixed

- Hide `kind: KubernetesOperator` API registration behind the `bindings.enable` feature flag by @hjkatz in [#504](https://github.com/ngrok/ngrok-operator/pull/504)

## 0.13.2
**Full Changelog**: https://github.com/ngrok/ngrok-operator/compare/ngrok-operator-0.13.1...ngrok-operator-0.13.2

Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.13.2
0.13.3
25 changes: 25 additions & 0 deletions docs/developer-guide/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,31 @@
- [Helm Chart](#helm-chart-1)
- [Controller](#controller)

# Release Steps

Overview:
1. Create a new branch like `release-ngrok-operator-<version>`
1. Update versions and changelogs
1. Submit a PR to `main`
1. Merge PR (triggers `.github/workflows` to publish the new release)

Determine:
* The Helm Chart version: `helm/ingress-operator/Chart.yaml`
* The ngrok-op App version: `VERSION`

Steps:
* App Version Bump
1. Update `VERSION` to new version
1. Write a new section in `CHANGELOG`
* Note: Use the expected tag `ngrok-operator-<VERSION>` for the full
changelog (this tag will be created for you when your release PR is merged)
* Note: Find the new commits using a link, such as `https://github.com/ngrok/ngrok-operator/compare/ngrok-operator-<version>...main`
* Helm Chart Version Bump
1. Update `version` to new version
1. Update the `appVersion` to the desired `VERSION`
1. Write a new section in `CHANGELOG`
1. Run `$ make helm-update-snapshots helm-test`

## Artifacts

The ngrok Ingress Controller has 2 main artifacts, a docker image and a helm chart.
Expand Down
11 changes: 11 additions & 0 deletions helm/ngrok-operator/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ All notable changes to the helm chart will be documented in this file. Please se
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 0.16.0
**Full Changelog**: https://github.com/ngrok/ngrok-operator/compare/helm-chart-0.16.0...helm-chart-0.15.0

### Added

- Add support for 1-click demo mode by @hjkatz in [#503](https://github.com/ngrok/ngrok-operator/pull/503)

### Changed

- Bump image version to `0.13.3`

## 0.16.0-rc.3
**Full Changelog**: https://github.com/ngrok/ngrok-operator/compare/helm-chart-0.16.0-rc.2...helm-chart-0.16.0-rc.3

Expand Down
4 changes: 2 additions & 2 deletions helm/ngrok-operator/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
apiVersion: v2
name: ngrok-operator
description: The official ngrok Kubernetes Operator.
version: 0.16.0-rc.3
appVersion: 0.13.2
version: 0.16.0
appVersion: 0.13.3
keywords:
- ngrok
- networking
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d3feb24

Please sign in to comment.