Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update workflow documentation #108

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update workflow documentation #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa97d4c
update documentation
sk593 Jan 13, 2025
4d68ac3
update contributing doc
sk593 Jan 13, 2025
61c7978
Merge branch 'main' into update-documentation
sk593 Jan 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This Repository is part of the Radius project. For general information please se

- [Building the repo](./docs/contributing/contributing-code/contributing-code-building/)
- [Understanding repo organization](./docs/contributing/contributing-code/contributing-code-organization/)
- [Understanding repo workflows](./docs/contributing/contributing-code/contributing-code-workflows/)

## Current status

Expand Down
13 changes: 13 additions & 0 deletions docs/contributing/contributing-code/contributing-code-workflows/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Understanding the bicep-types-aws workflows

This document describes the workflows that run during pull requests to the bicep-types-aws repository.

## `build.yaml`

This workflow is used to build and test the AWS downloader and AWS generator to ensure that no errors or bugs are present when we download the AWS resource type schema from the CloudControl API. The tests run as part of this workflow can be found under `src/aws-type-generator/src/convert.test.ts`.

## `approve-publish.yaml` and `publish-bicep.yaml`

These workflows are used hand-in-hand to publish the generated Bicep types to ACR. The `publish-bicep.yaml` workflow downloads and generates the latest AWS resource type schemas into Bicep types and handles uploading Bicep types to ACR. We have to be able to authenticate to Azure from Github pipeline runs in order to publish the types. This requires pull requests (opened from the main repository and from forks) to have access to authentication secrets when the publish workflow is running.

We give pull requests access to run the publish workflow using the `approve-publish.yaml` workflow. This workflow must be approved by a maintainer or an approver of the repo to start and also kicks of a run of the `publish-bicep.yaml` workflow in a secure, trusted environment with access to the necessary secrets.
Loading