9 have cicd been setup for the basic structure (#11)

* docs: update RELEASE.md with the correct workflow

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -33,7 +33,6 @@ body:
   - type: textarea
     attributes:
       label: Anything else
-      description: Further hints, links, or references? Any additional information
-        probably helping in root cause analysis.
+      description: Further hints, links, or references? Any additional information probably helping in root cause analysis.
     validations:
       required: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -17,10 +17,8 @@ body:
   - type: textarea
     attributes:
       label: Motivation
-      description: Describe additional context such as examples or use cases helping
-        in understanding the feature request.
-      placeholder: 'This feature would be helpful because ... so that the following
-        use case is addressed: ...'
+      description: Describe additional context such as examples or use cases helping in understanding the feature request.
+      placeholder: 'This feature would be helpful because ... so that the following use case is addressed: ...'
     validations:
       required: true
   - type: textarea

.github/workflows/ci.yml

@@ -10,12 +10,10 @@ permissions:
   pull-requests: write
   packages: write
 env:
-  # login to GitHub registry using the default credentials associated with pipeline
   REGISTRY: ghcr.io
   REGISTRY_USERNAME: ${{ github.actor }}
   REGISTRY_PASSWORD: ${{ secrets.GITHUB_TOKEN }}
-  # Image name will be <account>/<repo>
-  IMAGE_NAME: ${{ github.repository }}
+  IMAGE_NAME: ${{ github.repository }}  # Image name will be <account>/<repo>
 jobs:
   release:
     runs-on: ubuntu-latest
@@ -38,8 +36,7 @@ jobs:
         env:
           # When release-please is skipped, these values will be empty
           is_release: ${{ steps.rp.outputs.release_created }}
-          version: v${{ steps.rp.outputs.major }}.${{ steps.rp.outputs.minor }}.${{
-            steps.rp.outputs.patch }}
+          version: v${{ steps.rp.outputs.major }}.${{ steps.rp.outputs.minor }}.${{ steps.rp.outputs.patch }}
         run: |
           tags=""
           if [[ "$is_release" = 'true' ]]; then
@@ -61,10 +58,8 @@ jobs:
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
           tags: ${{ steps.tags.outputs.tags }}
-      # necessary for multi-platform images
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
-      # necessary for multi-platform images
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
       - name: Build and push
@@ -76,5 +71,4 @@ jobs:
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           platforms: linux/amd64,linux/arm64
-# (optional) Add build arguments. I like to have the version available to the build so the app can show it.
           build-args: APP_VERSION=${{ steps.meta.outputs.version }}

.pre-commit-config.yaml

@@ -2,10 +2,10 @@
 default_install_hook_types: [pre-commit, commit-msg]
 repos:
   - repo: https://github.com/lyz-code/yamlfix
-    rev: 1.13.0
+    rev: 1.16.0
     hooks:
       - id: yamlfix
-        args: [-c .yamlfix]
+        args: [-c, .yamlfix.toml]
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:
@@ -14,7 +14,6 @@ repos:
       - id: check-xml
       - id: check-json
       - id: check-yaml
-      - id: detect-private-key
       - id: no-commit-to-branch
       - id: mixed-line-ending
   - repo: https://github.com/zricethezav/gitleaks

.yamlfix → .yamlfix.toml

@@ -1,3 +1,3 @@
 allow_duplicate_keys = false
-line_length = 120
+line_length = 180
 sequence_style = "flow_style"

RELEASE.md

@@ -5,15 +5,21 @@
 
 Releases within our project are exclusively overseen by designated code owners, as outlined in the [/ .github / CODEOWNERS](/.github/CODEOWNERS) file. Our release process is automated using the Release Please GitHub action, which is configured in [/ .github / workflows / release-please.yml](/.github/workflows/release-please.yml).
 
-## Overview of the Workflow:
+## Workflow Overview
 
-1. For the initial release, the Release Please GitHub action generates a pull request entitled "chore(main): release 1.0.0", marking the commencement of version 1.0.0. This pull request necessitates approval as required.
+1. **Initial Release**:
+    - The Release Please GitHub action generates a pull request titled `chore(main): release 1.0.0`, initiating version 1.0.0.
+    - This pull request requires approval from the designated code owners.
 
-2. Following the triumphant launch of the initial version, the action automatically generates another pull request to advance the version to 1.0.1-SNAPSHOT. Prompt approval of this pull request is encouraged post the inaugural release.
+2. **Subsequent Releases**:
+    - When changes are merged into the main branch, the Release Please GitHub action creates or updates an existing pull request titled `chore(main): release X.Y.Z`, where X.Y.Z is the version number derived from the commit history.
 
-3. Whenever alterations are introduced to the main branch, the Release Please GitHub action dynamically creates or updates the existing pull request, titled "chore(main): release X.Y.Z", where X.Y.Z denotes the version calculated based on Git message history.
+3. **Forcing a Specific Release Version**:
+    - To manually set the next release version, create an empty commit on a new branch and merge it manually. Use the following command to create the empty commit:
 
-4. Subsequent to each release, the process iterates to update the version to X.Y.Z-SNAPSHOT, thereby preparing a new pull request for the forthcoming X.Y.Z version release.
+    ```sh
+    git commit --allow-empty -m "chore: release 62.1.0" -m "Release-As: 62.1.0"
+    ```
+    - Then, create a pull request from this branch and merge it manually.
 
-
-For comprehensive information, please consult the [Release Please documentation](https://github.com/googleapis/release-please).
+For comprehensive information, please consult the [Release Please documentation](https://github.com/googleapis/release-please).