chore(deps): update stakater/.github action to v0.0.73 (#648)

* chore(deps): update stakater/.github action to v0.0.73

* update

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Karl Johan Grahn <karl.johan@stakater.com>

.github/workflows/pull_request.yaml

@@ -13,12 +13,6 @@ env:
   REGISTRY: ghcr.io
 
 jobs:
-  qa:
-    uses: stakater/.github/.github/workflows/pull_request_doc_qa.yaml@v0.0.65
-    with:
-      MD_CONFIG: .github/md_config.json
-      DOC_SRC: README.md docs
-      MD_LINT_CONFIG: .markdownlint.yaml
   build:
     runs-on: ubuntu-latest
     name: Build
@@ -50,7 +44,7 @@ jobs:
         make install
 
     - name: Run golangci-lint
-      uses: golangci/golangci-lint-action@v4
+      uses: golangci/golangci-lint-action@v5
       with:
         version: latest
         only-new-issues: false

.github/workflows/pull_request_docs.yaml

@@ -0,0 +1,32 @@
+name: Pull Request for Documentation Changes
+
+on:
+  pull_request_target:
+    branches:
+      - master
+    paths:
+      - '.markdownlint.yaml'
+      - '.vale.ini'
+      - 'Dockerfile-docs'
+      - 'docs-nginx.conf'
+      - 'docs/**'
+      - 'README.md'
+      - 'theme_common'
+      - 'theme_override'
+
+jobs:
+  qa:
+    uses: stakater/.github/.github/workflows/pull_request_doc_qa.yaml@v0.0.73
+    with:
+      MD_CONFIG: .github/md_config.json
+      DOC_SRC: README.md docs
+      MD_LINT_CONFIG: .markdownlint.yaml
+  build:
+    uses: stakater/.github/.github/workflows/pull_request_container_build.yaml@v0.0.73
+    with:
+      DOCKER_FILE_PATH: Dockerfile-docs
+    secrets:
+      CONTAINER_REGISTRY_URL: ghcr.io/stakater/docs
+      CONTAINER_REGISTRY_USERNAME: stakater-user
+      CONTAINER_REGISTRY_PASSWORD: ${{ secrets.STAKATER_GITHUB_TOKEN }}
+      SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }}

.github/workflows/push.yaml

@@ -44,7 +44,7 @@ jobs:
           make install
 
       - name: Run golangci-lint
-        uses: golangci/golangci-lint-action@v4
+        uses: golangci/golangci-lint-action@v5
         with:
           version: latest
           only-new-issues: false

.github/workflows/push_docs.yaml

@@ -0,0 +1,28 @@
+name: Push Documentation Changes
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - '.markdownlint.yaml'
+      - '.vale.ini'
+      - 'Dockerfile-docs'
+      - 'docs-nginx.conf'
+      - 'docs/**'
+      - 'README.md'
+      - 'theme_common'
+      - 'theme_override'
+
+jobs:
+  push:
+    uses: stakater/.github/.github/workflows/push_container.yaml@v0.0.73
+    with:
+      DOCKER_FILE_PATH: Dockerfile-docs
+      RELEASE_BRANCH: master
+    secrets:
+      CONTAINER_REGISTRY_URL: ghcr.io/stakater/docs
+      CONTAINER_REGISTRY_USERNAME: stakater-user
+      CONTAINER_REGISTRY_PASSWORD: ${{ secrets.STAKATER_GITHUB_TOKEN }}
+      SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }}
+      GH_TOKEN: ${{ secrets.STAKATER_GITHUB_TOKEN }}

.gitignore

@@ -13,3 +13,5 @@ Reloader
 !**/chart/reloader
 *.tgz
 styles/
+site/
+/mkdocs.yml

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "theme_common"]
+	path = theme_common
+	url = git@github.com:stakater/stakater-docs-mkdocs-theme.git

.vale.ini

@@ -1,7 +1,7 @@
 StylesPath = styles
 MinAlertLevel = warning
 
-Packages = https://github.com/stakater/vale-package/releases/download/v0.0.15/Stakater.zip
+Packages = https://github.com/stakater/vale-package/releases/download/v0.0.18/Stakater.zip
 Vocab = Stakater
 
 # Only check MarkDown files

CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Code of Conduct
+
+Reloader follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

Dockerfile-docs

@@ -0,0 +1,35 @@
+FROM python:3.12 as builder
+
+# set workdir
+RUN mkdir -p $HOME/application
+WORKDIR $HOME/application
+
+# copy the entire application
+COPY --chown=1001:root . .
+
+RUN pip3 install -r theme_common/requirements.txt
+
+# Combine Theme Resources
+RUN python theme_common/scripts/combine_theme_resources.py theme_common/resources theme_override/resources dist/_theme
+# Produce mkdocs file
+RUN python theme_common/scripts/combine_mkdocs_config_yaml.py theme_common/mkdocs.yml theme_override/mkdocs.yml mkdocs.yml
+
+# build the docs
+RUN mkdocs build
+
+FROM nginxinc/nginx-unprivileged:1.26-alpine as deploy
+COPY --from=builder $HOME/application/site/ /usr/share/nginx/html/reloader/
+COPY docs-nginx.conf /etc/nginx/conf.d/default.conf
+
+# set non-root user
+USER 1001
+
+LABEL name="Stakater Reloader Documentation" \
+      maintainer="Stakater <hello@stakater.com>" \
+      vendor="Stakater" \
+      release="1" \
+      summary="Documentation for Stakater Reloader"
+
+EXPOSE 8080:8080/tcp
+
+CMD ["nginx", "-g", "daemon off;"]

MAINTAINERS

@@ -0,0 +1,5 @@
+Bharath Nallapeta <bharath.nallapeta@stakater.com> (@bnallapeta)
+Karl Johan Grahn <karl.johan@stakater.com> (@karl-johan-grahn)
+Muhammad Sheryar Butt <sheryar@stakater.com> (@SheryarButt)
+Muneeb Aijaz <muneeb@stakater.com> (@MuneebAijaz)
+Tanveer Alam <tanveer.alam@stakater.com> (@tanalam2411)

deployments/kubernetes/chart/reloader/Chart.yaml

@@ -3,8 +3,8 @@
 apiVersion: v1
 name: reloader
 description: Reloader chart that runs on kubernetes
-version: 1.0.81
-appVersion: v1.0.81
+version: 1.0.85
+appVersion: v1.0.85
 keywords:
   - Reloader
   - kubernetes

deployments/kubernetes/chart/reloader/values.yaml

@@ -89,10 +89,10 @@ reloader:
     labels:
       provider: stakater
       group: com.stakater.platform
-      version: v1.0.81
+      version: v1.0.85
     image:
       name: ghcr.io/stakater/reloader
-      tag: v1.0.81
+      tag: v1.0.85
       pullPolicy: IfNotPresent
     # Support for extra environment variables.
     env:

deployments/kubernetes/manifests/deployment.yaml

@@ -17,7 +17,7 @@ spec:
         app: reloader-reloader
     spec:
       containers:
-        - image: "ghcr.io/stakater/reloader:v1.0.81"
+        - image: "ghcr.io/stakater/reloader:v1.0.85"
           imagePullPolicy: IfNotPresent
           name: reloader-reloader
           ports:

deployments/kubernetes/reloader.yaml

@@ -8,7 +8,7 @@ metadata:
     meta.helm.sh/release-name: "reloader"
   labels:
     app: reloader-reloader
-    chart: "reloader-1.0.81"
+    chart: "reloader-1.0.85"
     release: "reloader"
     heritage: "Helm"
     app.kubernetes.io/managed-by: "Helm"
@@ -25,7 +25,7 @@ metadata:
     meta.helm.sh/release-name: "reloader"
   labels:
     app: reloader-reloader
-    chart: "reloader-1.0.81"
+    chart: "reloader-1.0.85"
     release: "reloader"
     heritage: "Helm"
     app.kubernetes.io/managed-by: "Helm"
@@ -92,7 +92,7 @@ metadata:
     meta.helm.sh/release-name: "reloader"
   labels:
     app: reloader-reloader
-    chart: "reloader-1.0.81"
+    chart: "reloader-1.0.85"
     release: "reloader"
     heritage: "Helm"
     app.kubernetes.io/managed-by: "Helm"
@@ -115,13 +115,13 @@ metadata:
     meta.helm.sh/release-name: "reloader"
   labels:
     app: reloader-reloader
-    chart: "reloader-1.0.81"
+    chart: "reloader-1.0.85"
     release: "reloader"
     heritage: "Helm"
     app.kubernetes.io/managed-by: "Helm"
     group: com.stakater.platform
     provider: stakater
-    version: v1.0.81
+    version: v1.0.85
   name: reloader-reloader
   namespace: default
 spec:
@@ -135,16 +135,16 @@ spec:
     metadata:
       labels:
         app: reloader-reloader
-        chart: "reloader-1.0.81"
+        chart: "reloader-1.0.85"
         release: "reloader"
         heritage: "Helm"
         app.kubernetes.io/managed-by: "Helm"
         group: com.stakater.platform
         provider: stakater
-        version: v1.0.81
+        version: v1.0.85
     spec:
       containers:
-      - image: "ghcr.io/stakater/reloader:v1.0.81"
+      - image: "ghcr.io/stakater/reloader:v1.0.85"
         imagePullPolicy: IfNotPresent
         name: reloader-reloader
 

docs-nginx.conf

@@ -0,0 +1,11 @@
+server {
+    listen 8080;
+    root /usr/share/nginx/html/;
+    index index.html;
+    error_page 403 404 /404.html;
+    location = /404.html {
+        internal;
+    }
+    # redirects issued by nginx will be relative
+    absolute_redirect off;
+}

docs/Alerting.md

@@ -2,17 +2,17 @@
 
 Reloader can alert when it triggers a rolling upgrade on Deployments or StatefulSets. Webhook notification alert would be sent to the configured webhook server with all the required information.
 
-## Enabling the feature
+## Enabling
 
 In-order to enable this feature, you need to update the `reloader.env.secret` section of `values.yaml` providing the information needed for alert:
 
 ```yaml
-      ALERT_ON_RELOAD: [ true/false ] Default: false 
+      ALERT_ON_RELOAD: [ true/false ] Default: false
       ALERT_SINK: [ slack/teams/webhook ] Default: webhook
       ALERT_WEBHOOK_URL: Required if ALERT_ON_RELOAD is true
       ALERT_ADDITIONAL_INFO: Any additional information to be added to alert
 ```
 
-## Slack incoming-webhook creation docs
+## Slack Incoming-Webhook Creation Docs
 
 [Sending messages using Incoming Webhooks](https://api.slack.com/messaging/webhooks)

docs/How-it-works.md

@@ -1,4 +1,4 @@
-# How it works?
+# How does Reloader work?
 
 Reloader watches for `ConfigMap` and `Secret` and detects if there are changes in data of these objects. After change detection Reloader performs rolling upgrade on relevant Pods via associated `Deployment`, `Daemonset` and `Statefulset`.
 

docs/features.md

@@ -1,8 +0,0 @@
-# Features
-
-These are the key features of Reloader:
-
-1. Restart pod in a `deployment` on change in linked/related configmap's or secret's
-1. Restart pod in a `daemonset` on change in linked/related configmap's or secret's
-1. Restart pod in a `statefulset` on change in linked/related configmap's or secret's
-1. Restart pod in a `rollout` on change in linked/related configmap's or secret's

docs/index.md

@@ -0,0 +1,12 @@
+# Introduction
+
+Reloader can watch changes in `ConfigMap` and `Secret` and do rolling upgrades on Pods with their associated `DeploymentConfigs`, `Deployments`, `Daemonsets` `Statefulsets` and `Rollouts`.
+
+These are the key features of Reloader:
+
+1. Restart pod in a `deployment` on change in linked/related configmap's or secret's
+1. Restart pod in a `daemonset` on change in linked/related configmap's or secret's
+1. Restart pod in a `statefulset` on change in linked/related configmap's or secret's
+1. Restart pod in a `rollout` on change in linked/related configmap's or secret's
+
+This site contains more details on how Reloader works. For an overview, please see the repository's [README file](https://github.com/stakater/Reloader/blob/master/README.md).

internal/pkg/handler/upgrade.go

@@ -133,6 +133,7 @@ func sendWebhook(url string) (string, []error) {
 		// the reloader seems to retry automatically so no retry logic added
 		return "", err
 	}
+	defer resp.Body.Close()
 	var buffer bytes.Buffer
 	_, bufferErr := io.Copy(&buffer, resp.Body)
 	if bufferErr != nil {

theme_override/mkdocs.yml

@@ -0,0 +1,22 @@
+site_name: Stakater Reloader
+docs_dir: docs
+site_url: https://docs.stakater.com/reloader/
+repo_url: https://github.com/stakater/reloader
+edit_uri: blob/master/docs/
+
+theme:
+  favicon: assets/images/favicon.svg
+
+nav:
+  - index.md
+  - How-to Guides:
+    - Verify-Reloader-Working.md
+    - Alerting.md
+    - Reloader-with-Sealed-Secrets.md
+    - Helm2-to-Helm3.md
+  - References:
+    - How-it-works.md
+    - Container Build.md
+    - Comparisons with similar tools:
+      - Reloader-vs-ConfigmapController.md
+      - Reloader-vs-k8s-trigger-controller.md