8000 Simplify release script (#4425) · nginx/kubernetes-ingress@ecc04a1 · GitHub
[go: up one dir, main page]

Skip to content
.gLSgdJ{font-weight:600;color:var(--fgColor-default,var(--color-fg-default,#1F2328));}/*!sc*/ .gLSgdJ:hover{color:var(--fgColor-default,var(--color-fg-default,#1F2328));}/*!sc*/ .irPhWZ{width:60px;}/*!sc*/ .dNbsEP{width:62px;}/*!sc*/ .kHfwUD{width:60px;height:22px;}/*!sc*/ .bHLmSv{position:absolute;inset:0 -2px;cursor:col-resize;background-color:transparent;-webkit-transition-delay:0.1s;transition-delay:0.1s;}/*!sc*/ .bHLmSv:hover{background-color:var(--bgColor-neutral-muted,var(--color-neutral-muted,rgba(175,184,193,0.2)));}/*!sc*/ data-styled.g1[id="Box-sc-g0xbh4-0"]{content:"gLSgdJ,irPhWZ,dNbsEP,kHfwUD,bHLmSv,"}/*!sc*/ .hWlpPn{position:relative;display:inline-block;}/*!sc*/ .hWlpPn::after{position:absolute;z-index:1000000;display:none;padding:0.5em 0.75em;font:normal normal 11px/1.5 -apple-system,BlinkMacSystemFont,"Segoe UI","Noto Sans",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji";-webkit-font-smoothing:subpixel-antialiased;color:var(--tooltip-fgColor,var(--fgColor-onEmphasis,var(--color-fg-on-emphasis,#ffffff)));text-align:center;-webkit-text-decoration:none;text-decoration:none;text-shadow:none;text-transform:none;-webkit-letter-spacing:normal;-moz-letter-spacing:normal;-ms-letter-spacing:normal;letter-spacing:normal;word-wrap:break-word;white-space:pre;pointer-events:none;content:attr(aria-label);background:var(--tooltip-bgColor,var(--bgColor-emphasis,var(--color-neutral-emphasis-plus,#24292f)));border-radius:6px;opacity:0;}/*!sc*/ @-webkit-keyframes tooltip-appear{from{opacity:0;}to{opacity:1;}}/*!sc*/ @keyframes tooltip-appear{from{opacity:0;}to{opacity:1;}}/*!sc*/ .hWlpPn:hover::after,.hWlpPn:active::after,.hWlpPn:focus::after,.hWlpPn:focus-within::after{display:inline-block;-webkit-text-decoration:none;text-decoration:none;-webkit-animation-name:tooltip-appear;animation-name:tooltip-appear;-webkit-animation-duration:0.1s;animation-duration:0.1s;-webkit-animation-fill-mode:forwards;animation-fill-mode:forwards;-webkit-animation-timing-function:ease-in;animation-timing-function:ease-in;-webkit-animation-delay:0s;animation-delay:0s;}/*!sc*/ .hWlpPn.tooltipped-no-delay:hover::after,.hWlpPn.tooltipped-no-delay:active::after,.hWlpPn.tooltipped-no-delay:focus::after,.hWlpPn.tooltipped-no-delay:focus-within::after{-webkit-animation-delay:0s;animation-delay:0s;}/*!sc*/ .hWlpPn.tooltipped-multiline:hover::after,.hWlpPn.tooltipped-multiline:active::after,.hWlpPn.tooltipped-multiline:focus::after,.hWlpPn.tooltipped-multiline:focus-within::after{display:table-cell;}/*!sc*/ .hWlpPn.tooltipped-s::after,.hWlpPn.tooltipped-se::after,.hWlpPn.tooltipped-sw::after{top:100%;right:50%;margin-top:6px;}/*!sc*/ .hWlpPn.tooltipped-se::after{right:auto;left:50%;margin-left:-16px;}/*!sc*/ .hWlpPn.tooltipped-sw::after{margin-right:-16px;}/*!sc*/ .hWlpPn.tooltipped-n::after,.hWlpPn.tooltipped-ne::after,.hWlpPn.tooltipped-nw::after{right:50%;bottom:100%;margin-bottom:6px;}/*!sc*/ .hWlpPn.tooltipped-ne::after{right:auto;left:50%;margin-left:-16px;}/*!sc*/ .hWlpPn.tooltipped-nw::after{margin-right:-16px;}/*!sc*/ .hWlpPn.tooltipped-s::after,.hWlpPn.tooltipped-n::after{-webkit-transform:translateX(50%);-ms-transform:translateX(50%);transform:translateX(50%);}/*!sc*/ .hWlpPn.tooltipped-w::after{right:100%;bottom:50%;margin-right:6px;-webkit-transform:translateY(50%);-ms-transform:translateY(50%);transform:translateY(50%);}/*!sc*/ .hWlpPn.tooltipped-e::after{bottom:50%;left:100%;margin-left:6px;-webkit-transform:translateY(50%);-ms-transform:translateY(50%);transform:translateY(50%);}/*!sc*/ .hWlpPn.tooltipped-multiline::after{width:-webkit-max-content;width:-moz-max-content;width:max-content;max-width:250px;word-wrap:break-word;white-space:pre-line;border-collapse:separate;}/*!sc*/ .hWlpPn.tooltipped-multiline.tooltipped-s::after,.hWlpPn.tooltipped-multiline.tooltipped-n::after{right:auto;left:50%;-webkit-transform:translateX(-50%);-ms-transform:translateX(-50%);transform:translateX(-50%);}/*!sc*/ .hWlpPn.tooltipped-multiline.tooltipped-w::after,.hWlpPn.tooltipped-multiline.tooltipped-e::after{right:100%;}/*!sc*/ .hWlpPn.tooltipped-align-right-2::after{right:0;margin-right:0;}/*!sc*/ .hWlpPn.tooltipped-align-left-2::after{left:0;margin-left:0;}/*!sc*/ data-styled.g4[id="Tooltip__TooltipBase-sc-17tf59c-0"]{content:"hWlpPn,"}/*!sc*/ .haStJJ{position:relative;overflow:hidden;-webkit-mask-image:radial-gradient(white,black);mask-image:radial-gradient(white,black);background-color:var(--bgColor-neutral-muted,var(--color-neutral-subtle,rgba(234,238,242,0.5)));border-radius:3px;display:block;height:1.2em;width:60px;}/*!sc*/ .haStJJ::after{-webkit-animation:crVFvv 1.5s infinite linear;animation:crVFvv 1.5s infinite linear;background:linear-gradient(90deg,transparent,var(--bgColor-neutral-muted,var(--color-neutral-subtle,rgba(234,238,242,0.5))),transparent);content:'';position:absolute;-webkit-transform:translateX(-100%);-ms-transform:translateX(-100%);transform:translateX(-100%);bottom:0;left:0;right:0;top:0;}/*!sc*/ .gQPxIv{position:relative;overflow:hidden;-webkit-mask-image:radial-gradient(white,black);mask-image:radial-gradient(white,black);background-color:var(--bgColor-neutral-muted,var(--color-neutral-subtle,rgba(234,238,242,0.5)));border-radius:3px;display:block;height:1.2em;width:62px;}/*!sc*/ .gQPxIv::after{-webkit-animation:crVFvv 1.5s infinite linear;animation:crVFvv 1.5s infinite linear;background:linear-gradient(90deg,transparent,var(--bgColor-neutral-muted,var(--color-neutral-subtle,rgba(234,238,242,0.5))),transparent);content:'';position:absolute;-webkit-transform:translateX(-100%);-ms-transform:translateX(-100%);transform:translateX(-100%);bottom:0;left:0;right:0;top:0;}/*!sc*/ .hltGgV{position:relative;overflow:hidden;-webkit-mask-image:radial-gradient(white,black);mask-image:radial-gradient(white,black);background-color:var(--bgColor-neutral-muted,var(--color-neutral-subtle,rgba(234,238,242,0.5)));border-radius:3px;display:block;height:1.2em;width:60px;height:22px;}/*!sc*/ .hltGgV::after{-webkit-animation:crVFvv 1.5s infinite linear;animation:crVFvv 1.5s infinite linear;background:linear-gradient(90deg,transparent,var(--bgColor-neutral-muted,var(--color-neutral-subtle,rgba(234,238,242,0.5))),transparent);content:'';position:absolute;-webkit-transform:translateX(-100%);-ms-transform:translateX(-100%);transform:translateX(-100%);bottom:0;left:0;right:0;top:0;}/*!sc*/ data-styled.g14[id="LoadingSkeleton-sc-14d3f1fe-0"]{content:"haStJJ,gQPxIv,hltGgV,"}/*!sc*/ @-webkit-keyframes crVFvv{0%{-webkit-transform:translateX(-100%);-ms-transform:translateX(-100%);transform:translateX(-100%);}50%{-webkit-transform:translateX(100%);-ms-transform:translateX(100%);transform:translateX(100%);}100%{-webkit-transform:translateX(100%);-ms-transform:translateX(100%);transform:translateX(100%);}}/*!sc*/ @keyframes crVFvv{0%{-webkit-transform:translateX(-100%);-ms-transform:translateX(-100%);transform:translateX(-100%);}50%{-webkit-transform:translateX(100%);-ms-transform:translateX(100%);transform:translateX(100%);}100%{-webkit-transform:translateX(100%);-ms-transform:translateX(100%);transform:translateX(100%);}}/*!sc*/ data-styled.g42[id="sc-keyframes-crVFvv"]{content:"crVFvv,"}/*!sc*/

Commit ecc04a1

Browse files
authored
Simplify release script (#4425)
1 parent 1af4a28 commit ecc04a1

File tree

7 files changed

+54
-107
lines changed

7 files changed

+54
-107
lines changed

docs/content/installation/installation-with-operator.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ toc: true
88
docs: "DOCS-604"
99
---
1010

11-
{{< note >}}
12-
An NGINX Ingress Operator version compatible with the 3.2.0 NGINX Ingress Controller release is not available yet. We will update this document and remove this note once we publish a compatible Operator version.
13-
{{< /note >}}
14-
1511
This document describes how to install the F5 NGINX Ingress Controller in your Kubernetes cluster using the NGINX Ingress Operator.
1612

1713
## Prerequisites

hack/changelog-template.txt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
%%TITLE%%
2+
3+
%%RELEASE_DATE%%
4+
5+
### <i class="fa-solid fa-bomb"></i> Breaking Changes
6+
7+
### <i class="fa-solid fa-rocket"></i> Features
8+
9+
### <i class="fa-solid fa-bug-slash"></i> Fixes
10+
11+
### <i class="fa-solid fa-box"></i> Helm Chart
12+
13+
### <i class="fa-solid fa-upload"></i> Dependencies
14+
15+
### <i class="fa-solid fa-download"></i> Upgrade
16+
17+
- For NGINX, use the %%IC_VERSION%% images from our
18+
[DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/tags?page=1&ordering=last_updated&name=%%IC_VERSION%%),
19+
[GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress),
20+
[Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress).
21+
- For NGINX Plus, use the %%IC_VERSION%% images from the F5 Container registry,
22+
the [AWS Marketplace](https://aws.amazon.com/marketplace/search/?CREATOR=741df81b-dfdc-4d36-b8da-945ea66b522c&FULFILLMENT_OPTION_TYPE=CONTAINER&filters=CREATOR%2CFULFILLMENT_OPTION_TYPE),
23+
the [GCP Marketplace](https://console.cloud.google.com/marketplace/browse?filter=partner:F5,%20Inc.&filter=solution-type:k8s&filter=category:networking)
24+
or build your own image using the %%IC_VERSION%% source code
25+
- For Helm, use version %%HELM_CHART_VERSION%% of the chart.
26+
27+
### <i class="fa-solid fa-life-ring"></i> Supported Platforms
28+
29+
We will provide technical support for NGINX Ingress Controller on any Kubernetes platform that is currently supported by
30+
its provider and that passes the Kubernetes conformance tests. This release was fully tested on the following Kubernetes
31+
versions: x.xx-x.xx.

hack/minor-changelog-template.txt

Lines changed: 0 additions & 15 deletions
This file was deleted.

hack/operator-note.txt

Lines changed: 0 additions & 4 deletions
This file was deleted.

hack/prepare-major-release.sh

Lines changed: 0 additions & 28 deletions
This file was deleted.

hack/prepare-minor-release.sh

Lines changed: 0 additions & 32 deletions
This file was deleted.
Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
#!/usr/bin/env bash
22

3-
# Updates the files required for a new release. Run this script in the release branch. Use it from
4-
# hack/prepare-major-release.sh or hack/prepare-minor-release.sh
3+
# Updates the files required for a new release. Run this script in the release branch.
54
#
65
# Usage:
7-
# hack/common-release-prep.sh prev_ic_version ic-version prev_helm_chart_version helm-chart-version
6+
# hack/prepare-release.sh ic-version helm-chart-version
87
#
98
# Example:
10-
# hack/prepare-major-release.sh 1.12.1 1.13.0 0.10.1 0.11.0
9+
# hack/prepare-release.sh 3.3.0 1.0.0
10+
11+
DOCS_TO_UPDATE_FOLDER=docs/content
1112

1213
FILES_TO_UPDATE_IC_VERSION=(
13-
Makefile
1414
README.md
1515
deployments/daemon-set/nginx-ingress.yaml
1616
deployments/daemon-set/nginx-plus-ingress.yaml
@@ -29,15 +29,26 @@ FILE_TO_UPDATE_HELM_CHART_VERSION=(
2929
charts/nginx-ingress/README.md
3030
)
3131

32-
DOCS_TO_UPDATE_FOLDER=docs/content
32+
if [ $# != 2 ]; then
33+
echo "Invalid number of arguments" 1>&2
34+
echo "Usage: $0 ic-version helm-chart-version" 1>&2
35+
exit 1
36+
fi
37+
38+
ic_version=$1
39+
helm_chart_version=$2
40+
41+
current_ic_version=$(yq '.appVersion' <deployments/helm-chart/Chart.yaml)
42+
current_helm_chart_version=$(yq '.version' <deployments/helm-chart/Chart.yaml)
3343

34-
prev_ic_version=$1
35-
ic_version=$2
36-
prev_helm_chart_version=$3
37-
helm_chart_version=$4
44+
sed -i "" "s/$current_ic_version/$ic_version/g" ${FILES_TO_UPDATE_IC_VERSION[*]}
45+
sed -i "" "s/$current_helm_chart_version/$helm_chart_version/g" ${FILE_TO_UPDATE_HELM_CHART_VERSION[*]}
46+
find $DOCS_TO_UPDATE_FOLDER -type f -name "*.md" ! -name releases.md ! -name CHANGELOG.md -exec sed -i "" "s/$current_ic_version/$ic_version/g" {} +
3847

39-
sed -i "" "s/$prev_ic_version/$ic_version/g" ${FILES_TO_UPDATE_IC_VERSION[*]}
40-
sed -i "" "s/$prev_helm_chart_version/$helm_chart_version/g" ${FILE_TO_UPDATE_HELM_CHART_VERSION[*]}
48+
# update CHANGELOGs
49+
sed -i "" "8r hack/changelog-template.txt" $DOCS_TO_UPDATE_FOLDER/releases.md
50+
sed -i "" "1r hack/repo-changelog-template.txt" CHANGELOG.md
51+
sed -i "" -e "s/%%TITLE%%/## $ic_version/g" -e "s/%%IC_VERSION%%/$ic_version/g" -e "s/%%HELM_CHART_VERSION%%/$helm_chart_version/g" $DOCS_TO_UPDATE_FOLDER/releases.md CHANGELOG.md
4152

4253
# copy the helm chart README to the docs
4354
{
@@ -54,15 +65,3 @@ line_number=$(grep -n -e "|" docs/content/installation/installation-with-helm.md
5465
sed -i '' "${line_number}a\\
5566
{{% /table %}}
5667
" docs/content/installation/installation-with-helm.md
57-
58-
# update repo CHANGELOG
59-
sed -i "" "1r hack/repo-changelog-template.txt" CHANGELOG.md
60-
sed -i "" -e "s/%%TITLE%%/## $ic_version/g" -e "s/%%IC_VERSION%%/$ic_version/g" -e "s/%%HELM_CHART_VERSION%%/$helm_chart_version/g" CHANGELOG.md
61-
62-
# update docs
63-
find $DOCS_TO_UPDATE_FOLDER -type f -name "*.md" -exec sed -i "" "s/v$prev_ic_version/v$ic_version/g" {} +
64-
find $DOCS_TO_UPDATE_FOLDER/installation -type f -name "*.md" -exec sed -i "" "s/$prev_ic_version/$ic_version/g" {} +
65-
find $DOCS_TO_UPDATE_FOLDER/app-protect-* -type f -name "*.md" -exec sed -i "" "s/$prev_ic_version/$ic_version/g" {} +
66-
67-
# update IC version in the technical-specification doc
68-
sed -i "" "s/$prev_ic_version/$ic_version/g" $DOCS_TO_UPDATE_FOLDER/technical-specifications.md

0 commit comments

Comments
 (0)
0