Add a workflow that checks that codegen is up-to-date. (#16)

* Add a workflow that checks that codegen is up-to-date.

Signed-off-by: Michael Johansen <[email protected]>

* Add git clean flags back in.

Signed-off-by: Michael Johansen <[email protected]>

* Used the wrong package name in the job title.

Signed-off-by: Michael Johansen <[email protected]>

* Fix comment.

Signed-off-by: Michael Johansen <[email protected]>

* Update the working directory for the git diff call so it actually sees diffs.

Signed-off-by: Michael Johansen <[email protected]>

* Try setting to ./ to get it to use the root dir.

Signed-off-by: Michael Johansen <[email protected]>

* Add a path argument to the diff command instead of using working-directory.

Signed-off-by: Michael Johansen <[email protected]>

* Try using the github_workspace env variable for the working-directory.

Signed-off-by: Michael Johansen <[email protected]>

* Maybe . will do it.

Signed-off-by: Michael Johansen <[email protected]>

* Remove default working directory and explicitly specify it where needed.

Signed-off-by: Michael Johansen <[email protected]>

* Try manually changing one of the codegen files to see if diff is failing because the latest change just added files.

Signed-off-by: Michael Johansen <[email protected]>

* Revert change to generated file.

Signed-off-by: Michael Johansen <[email protected]>

* Go back to using default run dir. Make a generated file change to make sure the diff still works.

* Try and handle untracked files by doing a git add and diffing staged.

Signed-off-by: Michael Johansen <[email protected]>

* Fix the working directory.

Signed-off-by: Michael Johansen <[email protected]>

* Revert codegened file change.

Signed-off-by: Michael Johansen <[email protected]>

* Get rid of cleanup step since each job runs in a separate docker container.

Signed-off-by: Michael Johansen <[email protected]>

* Rename workflow file and apply other review feedback.

Signed-off-by: Michael Johansen <[email protected]>

* Make proto-basepth optional.

Signed-off-by: Michael Johansen <[email protected]>

* Token change to get this PR to re-merge.

Signed-off-by: Michael Johansen <[email protected]>

---------

Signed-off-by: Michael Johansen <[email protected]>
Co-authored-by: Michael Johansen <[email protected]>

Author: mjohanse-emr

.github/workflows/CI.yml

@@ -9,9 +9,17 @@ on:
   workflow_dispatch:
 
 jobs:
+  check_codegen_ni_protobuf_types:
+    name: Check codegen up-to-date for ni.protobuf.types
+    uses: ./.github/workflows/check_codegen.yml
+    with:
+      proto-subpath: ni/protobuf/types
+      output-basepath: ../../packages/ni.protobuf.types/src
+      output-format: submodule
   check_ni_protobuf_types:
     name: Check ni.protobuf.types
     uses: ./.github/workflows/check_package.yml
+    needs: [check_codegen_ni_protobuf_types]
     with:
       package-name: ni.protobuf.types
   check_ni_pythonpanel_v1_proto:

.github/workflows/check_codegen.yml

@@ -0,0 +1,60 @@
+name: Check codegen up to date
+
+on:
+  workflow_call:
+    inputs:
+      proto-basepath:
+        description: 'The base path for proto files used for generation.'
+        default: '../../third_party/ni-apis'
+        type: string
+      proto-subpath:
+        description: 'The path to proto files relative to proto-base-path.'
+        default: ''
+        required: true
+        type: string
+      output-basepath:
+        description: 'The base output path for codegened files.'
+        default: ''
+        required: true
+        type: string
+      output-format:
+        description: 'The format for the generated stubs. Options are submodule and subpackage.'
+        default: ''
+        required: true
+        type: string
+
+jobs:
+  check_codegen:
+    name: Check codegen up to date
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        # Set the working-directory for all steps in this job.
+        working-directory: ./tools/grpc_generator
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          submodules: true
+      - name: Set up Python
+        uses: ni/python-actions/setup-python@5286c12d65d90b2ea738bd57d452dc4366497581 # v0.4.1
+        id: setup-python
+      - name: Set up Poetry
+        uses: ni/python-actions/setup-poetry@5286c12d65d90b2ea738bd57d452dc4366497581 # v0.4.1
+      - name: Check for lock changes
+        run: poetry check --lock
+      - name: Cache virtualenv
+        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
+        with:
+          path: tools/grpc_generator/.venv
+          key: grpc_generator-only-main-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('tools/grpc_generator/poetry.lock') }}
+      - name: Install grpc_generator
+        run: poetry install -v --only main
+      - name: Generate gRPC stubs
+        run: |
+          poetry run grpc-generator --proto-basepath ${{ inputs.proto-basepath }} --proto-subpath ${{ inputs.proto-subpath }} --output-basepath ${{ inputs.output-basepath }} --output-format ${{ inputs.output-format }}
+      - name: Check for out-of-date gRPC stubs
+        run: |
+          git add ${{ inputs.output-basepath }}
+          git diff --exit-code --staged ${{ inputs.output-basepath }}
+          git diff --exit-code ${{ inputs.output-basepath }}

.github/workflows/check_package.yml

@@ -8,7 +8,6 @@ on:
         default: ''
         required: true
         type: string
-  workflow_dispatch:
 
 jobs:
   check_package: