Skip to content

azurerm_dev_center - support new property for project_catalog_item_sync_enabled#29274

Merged
sreallymatt merged 4 commits intohashicorp:mainfrom
neil-yechenwei:devcenterprojectlevel
Jul 24, 2025
Merged

azurerm_dev_center - support new property for project_catalog_item_sync_enabled#29274
sreallymatt merged 4 commits intohashicorp:mainfrom
neil-yechenwei:devcenterprojectlevel

Conversation

@neil-yechenwei
Copy link
Contributor

@neil-yechenwei neil-yechenwei commented Apr 7, 2025

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 PR is to support new property for project_catalog_item_sync_enabled.

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 relevant 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)

--- PASS: TestAccDevCenter_complete (566.37s)
--- PASS: TestAccDevCenter_update (741.16s)
--- PASS: TestAccDevCenter_requiresImport (641.16s)
--- PASS: TestAccDevCenter_basic (541.16s)

Change Log

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

  • azurerm_dev_center - support new property for dev_center_project_catalog_item_sync_enabled

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 #28361

Note

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


* `resource_group_name` - (Required) Specifies the name of the Resource Group within which this Dev Center should exist. Changing this forces a new Dev Center to be created.

* `dev_center_project_catalog_item_sync_enabled` - (Optional) Should project catalogs associated with projects in this Dev Center can be configured to sync catalog items?
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the resource name is dev_center so this should be

Suggested change
* `dev_center_project_catalog_item_sync_enabled` - (Optional) Should project catalogs associated with projects in this Dev Center can be configured to sync catalog items?
* `project_catalog_item_sync_enabled` - (Optional) Should project catalogs associated with projects in this Dev Center can be configured to sync catalog items?

?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

@neil-yechenwei neil-yechenwei changed the title azurerm_dev_center - support new property for dev_center_project_catalog_item_sync_enabled azurerm_dev_center - support new property for project_catalog_item_sync_enabled May 28, 2025
@neil-yechenwei neil-yechenwei requested a review from katbyte May 28, 2025 00:35
@neil-yechenwei
Copy link
Contributor Author

neil-yechenwei commented May 28, 2025

@katbyte , thanks for the comments. I updated PR. Please take another look. Below is the latest test result what I just now triggered.

--- PASS: TestAccDevCenter_complete (663.55s)
--- PASS: TestAccDevCenter_requiresImport (588.95s)
--- PASS: TestAccDevCenter_basic (619.91s)
--- PASS: TestAccDevCenter_update (939.52s)

Copy link
Collaborator

@sreallymatt sreallymatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @neil-yechenwei, I've left just a few minor comments inline

"tags": commonschema.Tags(),
"project_catalog_item_sync_enabled": {
Type: pluginsdk.TypeBool,
Optional: true,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're defaulting the value for this to CatalogItemSyncEnableStatusDisabled, could you add an explicit default of false to this property here and in the docs?

Suggested change
Optional: true,
Optional: true,
Default: false,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

Comment on lines +250 to +252
if v := input.Properties.ProjectCatalogSettings; v != nil && v.CatalogItemSyncEnableStatus != nil {
output.ProjectCatalogItemSyncEnabled = pointer.From(input.Properties.ProjectCatalogSettings.CatalogItemSyncEnableStatus) == devcenters.CatalogItemSyncEnableStatusEnabled
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Since we're assigning input.Properties.ProjectCatalogSettings to v we can just v.CatalogItemSyncEnableStatus instead, minor but just a bit shorter
  • We can remove the nil check on v.CatalogItemSyncEnableStatus since we're using pointer.From which will handle that for us
Suggested change
if v := input.Properties.ProjectCatalogSettings; v != nil && v.CatalogItemSyncEnableStatus != nil {
output.ProjectCatalogItemSyncEnabled = pointer.From(input.Properties.ProjectCatalogSettings.CatalogItemSyncEnableStatus) == devcenters.CatalogItemSyncEnableStatusEnabled
}
if v := input.Properties.ProjectCatalogSettings; v != nil {
output.ProjectCatalogItemSyncEnabled = pointer.From(v.CatalogItemSyncEnableStatus) == devcenters.CatalogItemSyncEnableStatusEnabled
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated


* `resource_group_name` - (Required) Specifies the name of the Resource Group within which this Dev Center should exist. Changing this forces a new Dev Center to be created.

* `project_catalog_item_sync_enabled` - (Optional) Should project catalogs associated with projects in this Dev Center can be configured to sync catalog items?
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you update this to be a statement rather than a question?

Suggested change
* `project_catalog_item_sync_enabled` - (Optional) Should project catalogs associated with projects in this Dev Center can be configured to sync catalog items?
* `project_catalog_item_sync_enabled` - (Optional) Whether the project catalogs associated with projects in this Dev Center are allowed to sync catalog items.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

@neil-yechenwei
Copy link
Contributor Author

@sreallymatt , thanks for the comments. I updated PR. Please take another look. Below is the latest test result what I just now triggered.

--- PASS: TestAccDevCenter_basic (599.15s)
--- PASS: TestAccDevCenter_complete (636.08s)
--- PASS: TestAccDevCenter_requiresImport (602.68s)
--- PASS: TestAccDevCenter_update (809.70s)

Copy link
Collaborator

@sreallymatt sreallymatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @neil-yechenwei LGTM ✅

@sreallymatt sreallymatt merged commit 62bbadc into hashicorp:main Jul 24, 2025
36 checks passed
@github-actions github-actions bot added this to the v4.38.0 milestone Jul 24, 2025
@github-actions
Copy link
Contributor

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 24, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support for Enabling per Project Level Catalog Sync

3 participants