.github/workflows/dependabot.yml → .github/workflows/automerge.yml

@@ -6,22 +6,22 @@ permissions:
   pull-requests: write
 
 jobs:
-  dependabot:
+  automerge:
     runs-on: ubuntu-latest
-    if: ${{ github.actor == 'dependabot[bot]' }}
+    if: ${{ github.actor == 'sszynrae' || github.actor == 'dependabot[bot]' }}
     steps:
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v1
+        uses: dependabot/fetch-metadata@v2
+        if: ${{ github.actor == 'dependabot[bot]' }}
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
       - name: Approve a PR
         run: gh pr review --approve "$PR_URL"
         env:
           PR_URL: ${{github.event.pull_request.html_url}}
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-      - name: Enable auto-merge for Dependabot PRs
-        #if: ${{contains(steps.metadata.outputs.dependency-names, 'my-dependency') && steps.metadata.outputs.update-type == 'version-update:semver-patch'}}
+      - name: Enable auto-merge for Dependency/Renovate PRs
         run: gh pr merge --auto --squash "$PR_URL"
         env:
           PR_URL: ${{github.event.pull_request.html_url}}

.github/workflows/ci.yml

@@ -20,15 +20,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
-        with:
-          override: true
-          toolchain: stable
-          profile: minimal
-      # Smart caching for Rust projects.
-      # Includes workaround for macos cache corruption.
-      # - https://github.com/rust-lang/cargo/issues/8603
-      # - https://github.com/actions/cache/issues/403
+      - uses: dtolnay/rust-toolchain@stable
       - uses: Swatinem/rust-cache@v2
 
       # Real CI work starts here
@@ -42,31 +34,29 @@ jobs:
         if: false # currently go doc generates stuff that rust expects to be valid symbols
 
   codegen:
-    strategy:
-      # Prevent GitHub from cancelling all in-progress jobs when a matrix job fails.
-      fail-fast: false
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
-        with:
-          override: true
-          toolchain: stable
-          profile: minimal
-      # Smart caching for Rust projects.
-      # Includes workaround for macos cache corruption.
-      # - https://github.com/rust-lang/cargo/issues/8603
-      # - https://github.com/actions/cache/issues/403
+      # Dependencies
+      - uses: extractions/setup-just@v2
+      - uses: arduino/setup-protoc@v3
+      - name: install fd, sd, ripgrep
+        run: |
+          sudo apt-get install -y ripgrep
+          export FD_VER=10.2.0
+          export SD_VER=1.0.0
+          curl -sSL "https://github.com/sharkdp/fd/releases/download/v${FD_VER}/fd-v${FD_VER}-x86_64-unknown-linux-musl.tar.gz" \
+            | tar xz --strip-components=1 -C /usr/local/bin/
+          curl -sSL "https://github.com/chmln/sd/releases/download/v${SD_VER}/sd-v${SD_VER}-x86_64-unknown-linux-musl.tar.gz" \
+          | tar xz --strip-components=1 -C /usr/local/bin/
+      # Rust
+      - uses: dtolnay/rust-toolchain@stable
       - uses: Swatinem/rust-cache@v2
-      - uses: extractions/setup-just@v1
-      - run: |-
-          curl -sSL https://github.com/sharkdp/fd/releases/download/v8.7.1/fd-v8.7.1-i686-unknown-linux-gnu.tar.gz | tar xz -C /usr/local/bin --strip-components=1
-      - run: |-
-          curl -sSL https://github.com/chmln/sd/releases/download/v1.0.0/sd-v1.0.0-x86_64-unknown-linux-gnu.tar.gz | tar xz -C /usr/local/bin --strip-components=1
-      - uses: arduino/setup-protoc@v2
+      # Run codegen step-by-step
       - run: just protos
       - run: just swagger
       - run: just codegen
+      - run: just names
       - name: Ensure generated output is committed
         run: |
           if ! git diff --exit-code .; then

README.md

@@ -10,11 +10,14 @@ For now consider these structs a reference location for Kubernetes structs that
 See [docs.rs/k8s-pb](https://docs.rs/k8s-pb/latest/k8s_pb/).
 
 ## Build Process
-The code generation process consists of 3 steps;
+The code generation process consists of 4 steps;
 
 1. `just protos` - download and patch protobufs
 2. `just swagger` - download and transform openapi schema
 3. `just codegen` - combine info and build with prost
+4. `just names` - case alignment and `cargo fmt`
+
+This can be run in one step with `just generate`.
 
 The [k8s-pb](https://github.com/kube-rs/k8s-pb/tree/main/k8s-pb) crate is generated as a result of this process and then published periodically.
 
@@ -43,9 +46,7 @@ Runs [main.rs](https://github.com/kube-rs/k8s-pb/blob/main/k8s-pb-codegen/src/ma
 
 - The protos are built with [prost](https://github.com/tokio-rs/prost) via `protoc` and provides a [`FileDescriptorSet`](https://docs.rs/prost-types/latest/prost_types/struct.FileDescriptorSet.html) via [`Config::file_descriptor_set_path`](https://docs.rs/prost-build/latest/prost_build/struct.Config.html#method.file_descriptor_set_path).
 - The transformed swagger result json is deserialized through [lib.rs](https://github.com/kube-rs/k8s-pb/blob/main/k8s-pb-codegen/src/lib.rs) into a `HashMap<String, Resource>` where the string is a GVK string.
-- We loop through all the generated modules and
-  * inject generics from this hashmap via `append_trait_impl`
-  * in memory `rustfmt` before finalising
+- inject generics for each modules in hashmap via `append_trait_impl`
 - Generate a module tree from the seen modules in the loop
 - Attach our implemented traits to the [generated lib.rs](https://github.com/kube-rs/k8s-pb/blob/main/k8s-pb/src/lib.rs)
 
@@ -55,3 +56,6 @@ Runs [main.rs](https://github.com/kube-rs/k8s-pb/blob/main/k8s-pb-codegen/src/ma
 - [jq](https://stedolan.github.io/jq/)
 - [just](https://github.com/casey/just)
 - [sd](https://github.com/chmln/sd)
+- [ripgrep](https://github.com/BurntSushi/ripgrep)
+- [protoc](https://github.com/protocolbuffers/protobuf)
+- [rustmft](https://github.com/rust-lang/rustfmt)

justfile

@@ -1,4 +1,7 @@
-VERSION := "1.29.0"
+# renovate: datasource=github-releases depName=kubernetes/kubernetes
+KUBERNETES_VERSION := "1.31.2"
+
+export RUST_BACKTRACE := env_var_or_default("RUST_BACKTRACE", "full")
 
 default:
   @just --list
@@ -11,7 +14,7 @@ protos-dl:
     rm -rf protos && mkdir protos && cd protos
     for x in api apimachinery apiextensions-apiserver kube-aggregator metrics; do
         mkdir -p ./$x
-        curl -sSL https://github.com/kubernetes/$x/archive/refs/tags/kubernetes-{{VERSION}}.tar.gz | tar xzf - -C ./$x/ --strip-components=1
+        curl -sSL https://github.com/kubernetes/$x/archive/refs/tags/kubernetes-{{KUBERNETES_VERSION}}.tar.gz | tar xzf - -C ./$x/ --strip-components=1
         fd -e proto -x sh -c "mkdir -p k8s.io/'{//}'; mv '{}' k8s.io/'{}'" ';' . ./$x
         rm -rf ./$x
     done
@@ -31,7 +34,8 @@ protos-list:
     #!/usr/bin/env bash
     set -exuo pipefail
     cd k8s-pb-codegen
-    fd -e proto | sort > protos.list
+    sort --version
+    fd -e proto | sort -fd > protos.list
 
 # Download and generate all protos dependent files
 protos: protos-dl protos-patch protos-list
@@ -41,7 +45,7 @@ swagger-dl:
     #!/usr/bin/env bash
     set -exuo pipefail
     curl -sSL -o k8s-pb-codegen/openapi/swagger.json \
-        https://raw.githubusercontent.com/kubernetes/kubernetes/v{{VERSION}}/api/openapi-spec/swagger.json
+        https://raw.githubusercontent.com/kubernetes/kubernetes/v{{KUBERNETES_VERSION}}/api/openapi-spec/swagger.json
 
 # Patch swagger schema for upstream bugs
 swagger-patch:
@@ -71,3 +75,30 @@ codegen:
     cd k8s-pb-codegen
     rm -rf tmp/ && mkdir tmp
     cargo run
+
+# Align names and format
+names:
+    #!/usr/bin/env bash
+    # Retain original names (prost doesn't let you bypass its renaming)
+    rg 'ApiService' k8s-pb -l | xargs sd 'ApiService' 'APIService'
+    rg 'ApiResource' k8s-pb -l | xargs sd 'ApiResource' 'APIResource'
+    rg 'ApiGroup' k8s-pb -l | xargs sd 'ApiGroup' 'APIGroup'
+    rg 'ApiVersion' k8s-pb -l | xargs sd 'ApiVersion' 'APIVersion'
+    rg 'ApiSubresource' k8s-pb -l | xargs sd 'ApiSubresource' 'APISubresource'
+    rg 'DownwardApi' k8s-pb -l | xargs sd 'DownwardApi' 'DownwardAPI'
+    rg 'CsiDriver' k8s-pb -l | xargs sd 'CsiDriver' 'CSIDriver'
+    rg 'CsiPersistent' k8s-pb -l | xargs sd 'CsiPersistent' 'CSIPersistent'
+    rg 'CsiVolume' k8s-pb -l | xargs sd 'CsiVolume' 'CSIVolume'
+    rg 'CsiStorage' k8s-pb -l | xargs sd 'CsiStorage' 'CSIStorage'
+    rg 'CsiNode' k8s-pb -l | xargs sd 'CsiNode' 'CSINode'
+    rg 'IpAddress' k8s-pb -l | xargs sd 'IpAddress' 'IPAddress'
+    rg 'ServiceCidr' k8s-pb -l | xargs sd 'ServiceCidr' 'ServiceCIDR'
+    rg 'ClusterCidr' k8s-pb -l | xargs sd 'ClusterCidr' 'ClusterCIDR'
+    rg 'ClientCidr' k8s-pb -l | xargs sd 'ClientCidr' 'ClientCIDR'
+    rg 'cluster_i_ps' k8s-pb -l | xargs sd 'cluster_i_ps' 'cluster_ips'
+    rg 'external_i_ps' k8s-pb -l | xargs sd 'external_i_ps' 'external_ips'
+    rg 'pod_i_ps' k8s-pb -l | xargs sd 'pod_i_ps' 'pod_ips'
+    rg 'host_i_ps' k8s-pb -l | xargs sd 'host_i_ps' 'host_ips'
+    cargo fmt
+
+generate: swagger protos codegen names

k8s-pb-codegen/Cargo.toml

@@ -1,19 +1,17 @@
 [package]
 name = "k8s-pb-codegen"
-version = "0.2.0"
-edition = "2018"
+version = "0.3.0"
+edition = "2021"
 license = "Apache-2.0"
 publish = false
 
 [dependencies]
-bytes = "1.0.1"
-prost = "0.12.3"
-prost-build = "0.12.3"
-prost-types = "0.12.3"
+prost = "0.13.1"
+prost-build = "0.13.1"
+prost-types = "0.13.1"
 serde_json = "1.0.67"
 serde = { version = "1.0.130", features = ["derive"] }
 log = "0.4.14"
 anyhow = "1.0.44"
-env_logger = "0.10.1"
+env_logger = "0.11.0"
 quote = "1.0"
-heck = "0.4"