Update build workflow to publish bicep types to ACR #7693

sk593 · 2024-06-18T22:50:21Z

Description

Update build workflow to publish bicep types to ACR

Type of change

This pull request fixes a bug in Radius and has an approved issue (issue link required).
This pull request adds or changes features of Radius and has an approved issue (issue link required).
This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).

Fixes: #issue_number

sk593 · 2024-06-18T22:52:25Z

.github/workflows/build.yaml

+    name: Publish Radius bicep types to ACR
+    runs-on: ubuntu-latest
+        # Don't push on PR 
+    if: github.repository == 'radius-project/radius' && ((startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main'))


The idea is that we only publish on merge to main or during a release in this workflow. The functional test workflow will also have a step to publish types to ACR and these will be tagged with the PR version.

Open to suggestions if that doesn't sound like the right idea. Since the functional tests are where we'd consume the uploaded types (i.e. in all our test bicep templates), it made most sense to upload them as part of that workflow instead of here

Open to suggestions if that doesn't sound like the right idea. Since the functional tests are where we'd consume the uploaded types (i.e. in all our test bicep templates), it made most sense to upload them as part of that workflow instead of here

We could do that, or we could keep the bicep types on disk.

For the functional tests, we'll need to update/generate a bicep config to either:

Reference the specific version associated with the PR from the OCI registry (like we do with magpie)

Reference a file on disk

For the purposes of this PR, I think you have the right idea 👍

The plan was to generate a temporary bicep config in the functional test folder that has the PR-specific provider reference during pipeline runs. So we upload to ACR with the PR-specific tag and then the tests will pull from that provider tag.

There will be a bicep config that permanently lives in the radius folder, but this will mostly be for development purposes and will always reference the latest tag by default

.github/workflows/build.yaml

sk593 · 2024-06-18T22:55:28Z

.github/workflows/build.yaml

+          echo "OK"
+      - name: Generate Bicep extensibility types from OpenAPI specs
+        run: |
+          make generate-bicep-types VERSION=${{ env.REL_VERSION }}


There's code in generate.mk and generate.ts that takes in a version string as an argument and uses that to correctly tag the index.json file. So we'll pass in the release version here (default value is latest)

.github/workflows/build.yaml

rynowak · 2024-06-19T16:03:04Z

hack/bicep-types-radius/src/generator/src/cmd/generate.ts

@@ -256,7 +256,7 @@ async function buildTypeIndex(logger: ILogger, baseDir: string, version: string)
      types: readTypesJson(content),
    });
  }
-  const indexContent = await buildIndex(typeFiles,  log => logOut(logger, log), {name: "radius", version: version, isSingleton: false} as TypeSettings);
+  const indexContent = await buildIndex(typeFiles,  log => logOut(logger, log), {name: "radius", version: (version == "edge" ? "latest" : version), isSingleton: false} as TypeSettings);


it would be nice if we could keep the logic about edge/latest out of this code and limit to the GH actions + makefile.

Makes sense. Removed the check from here and added it to the build workflow instead

github-actions · 2024-06-19T17:57:37Z

Unit Tests

3 218 tests ±0 3 212 ✅ ±0 4m 6s ⏱️ +14s
261 suites ±0 6 💤 ±0
1 files ±0 0 ❌ ±0

Results for commit bf5deb2. ± Comparison against base commit d9af59d.

♻️ This comment has been updated with latest results.

.github/workflows/build.yaml

rynowak · 2024-06-19T20:36:09Z

.github/workflows/build.yaml

@@ -65,6 +65,9 @@ env:
  # URL to get source code for building the image
  IMAGE_SRC: https://github.com/radius-project/radius

+  # ACR url for bicep file uploads
+  ACR: 'biceptypes.azurecr.io'


Can you come up with a more descriptive name for this? It looks like my comment disappeared, but its still the same.

Ah, sorry I didnt see that comment. I updated to BICEP_TYPES_ACR, but I'm open to suggestions if something else seems better

I'd suggest something like BICEP_TYPES_REGISTRY. It's more neutral.

codecov · 2024-06-19T20:58:49Z

Codecov Report

Attention: Patch coverage is 0% with 12 lines in your changes missing coverage. Please review.

Project coverage is 60.99%. Comparing base (bb8da88) to head (bf5deb2).

❗ Current head bf5deb2 differs from pull request most recent head 6dcc571

Please upload reports for the commit 6dcc571 to get more accurate results.

Files	Patch %	Lines
pkg/cli/bicep/tools/download_tools.go	0.00%	12 Missing ⚠️

Additional details and impacted files

@@                       Coverage Diff                        @@
##           feature-bicep-compiler-merge    #7693      +/-   ##
================================================================
- Coverage                         61.01%   60.99%   -0.03%     
================================================================
  Files                               520      520              
  Lines                             27008    27012       +4     
================================================================
- Hits                              16480    16476       -4     
- Misses                             9077     9083       +6     
- Partials                           1451     1453       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: sk593 <shruthikumar@microsoft.com>

# Description Update build workflow to publish bicep types to ACR ## Type of change  - This pull request fixes a bug in Radius and has an approved issue (issue link required). - This pull request adds or changes features of Radius and has an approved issue (issue link required). - This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).  Fixes: #issue_number --------- Signed-off-by: sk593 <shruthikumar@microsoft.com>

sk593 requested review from a team as code owners June 18, 2024 22:50

sk593 commented Jun 18, 2024

View reviewed changes

.github/workflows/build.yaml Outdated Show resolved Hide resolved

sk593 commented Jun 18, 2024

View reviewed changes