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.

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

Adding resource "azurerm_static_web_app_build" to set environment variables for Preview Environment #28096

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lee0210
Copy link

@lee0210 lee0210 commented Nov 24, 2024

Community Note

  • Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
  • Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

This pull request introduces a new resource, azurerm_static_web_app_build, designed to configure environment variables specifically for the preview environment of a static web app. The existing azurerm_static_web_app resource only supports setting environment variables for the production environment via the app_settings property.

Below is an example of how to use the resource.

resource "azurerm_static_web_app_build" "preview" {
  name                     = azurerm_static_web_app.this.name
  resource_group_name      = azurerm_resource_group.this.name
  build                    = "preview"
  environment_variables    = {
    "X_API_KEY" = "API Key"
  }
}

PR Checklist

  • I have followed the guidelines in our Contributing Documentation.
  • I have checked to ensure there aren't other open Pull Requests for the same update/change.
  • I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
  • I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
  • I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
    For example: “resource_name_here - description of change e.g. adding property new_property_name_here

Changes to existing Resource / Data Source

  • I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
  • I have written new tests for my resource or datasource changes & updated any relevent documentation.
  • I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
  • (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

  • My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Because it needs to deploy something to the Static Web to create a preview environment, which is not currently supported without SWA or AZ cli, the tests are done manually. Please find the test evidence below.

Create a new resource
Screenshot 2024-11-24 at 21 29 15
Screenshot 2024-11-24 at 21 29 33

Destroy a resource
Screenshot 2024-11-24 at 21 30 13
Screenshot 2024-11-24 at 21 30 24

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

  • azurerm_resource - support for the thing1 property [GH-00000]

This is a (please select all that apply):

  • Bug Fix
  • New Feature (ie adding a service, resource, or data source)
  • Enhancement
  • Breaking Change

Related Issue(s)

Fixes #0000

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants