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

feat: Add new ptn modules azd/apim-api #3206

Merged
merged 7 commits into from
Sep 10, 2024

Conversation

jianingwang123
Copy link
Contributor

Description

Fixes Azure/Azure-Verified-Modules/issues#1232

Pipeline Reference

Pipeline
avm.ptn.azd.apim-api

Type of Change

  • Update to CI Environment or utilities (Non-module affecting changes)
  • Azure Verified Module updates:
    • Bugfix containing backwards-compatible bug fixes, and I have NOT bumped the MAJOR or MINOR version in version.json:
      • Someone has opened a bug report issue, and I have included "Closes #{bug_report_issue_number}" in the PR description.
      • The bug was found by the module author, and no one has opened an issue to report it yet.
    • Feature update backwards compatible feature updates, and I have bumped the MINOR version in version.json.
    • Breaking changes and I have bumped the MAJOR version in version.json.
    • Update to documentation

Checklist

  • I'm sure there are no other open Pull Requests for the same update/change
  • I have run Set-AVMModule locally to generate the supporting module files.
  • My corresponding pipelines / checks run clean and green without any errors or warnings

@jongio for notification.

@jianingwang123 jianingwang123 requested review from a team as code owners September 6, 2024 10:12
@avm-team-linter avm-team-linter bot added the Needs: Core Team 🧞 This item needs the AVM Core Team to review it label Sep 6, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the Needs: Triage 🔍 Maintainers need to triage still label Sep 6, 2024

Important

The "Needs: Triage 🔍" label must be removed once the triage process is complete!

Tip

For additional guidance on how to triage this issue/PR, see the BRM Issue Triage documentation.

@microsoft-github-policy-service microsoft-github-policy-service bot added the Type: AVM 🅰️ ✌️ Ⓜ️ This is an AVM related issue label Sep 6, 2024

Important

If this is a module-related PR, being submitted by the sole owner of the module, the AVM core team must review and approve it (as module owners can't approve their own PRs).

To indicate this PR needs the core team''s attention, apply the "Needs: Core Team 🧞" label!

The core team will only review and approve PRs that have this label applied!

@matebarabas matebarabas added the AZD 🧑‍💻 These modules are requested/used by the AZD team. label Sep 6, 2024
@matebarabas
Copy link
Contributor

@AlexanderSehr, @jianingwang123, good news: the MAR manifest has been updated with the required record(s) for this module. You can take the next steps accordingly. Thanks.

@matebarabas
Copy link
Contributor

matebarabas commented Sep 7, 2024

@jianingwang123, please make sure the following disclaimer is added to the readme.md of this module - preferably somewhere close to the top: "This module is not intended for broad, generic use, as it was designed to cater for the requirements of the AZD CLI product. Feature requests and bug fix requests are welcome if they support the development of the AZD CLI but may not be incorporated if they aim to make this module more generic than what it needs to be for its primary use case."

@v-xuto
Copy link
Member

v-xuto commented Sep 9, 2024

@AlexanderSehr Could you help review this PR?

@AlexanderSehr
Copy link
Contributor

Hey @jianingwang123,
just one small other comment. Otherwise it appears we're good to go. The only other thing that needs fixing are the conflicts 💪

@jianingwang123
Copy link
Contributor Author

@AlexanderSehr I have updated based on your comments, please re-review.

@AlexanderSehr AlexanderSehr merged commit 4ca0ccd into Azure:main Sep 10, 2024
4 checks passed
@AlexanderSehr
Copy link
Contributor

Hey @jianingwang123,
please note that the module publishing failed because the static test failed. As per the error, it seems the generated files where to up to date when merging the PR.
To solve this we need a few things:

  1. You need to create a new PR based on the latest code in main
  2. In that PR you need to introduce a change to the main.json file. It does not matter what it is (e.g., it can be a change to the module's description or a parameter), but it must be something that tells the CI 'hey something that justifies a new module version changed'
  3. You need to run the Set-AVMModule script again to make sure the files are up to date
  4. You ideally also run the pipeline again so that we can ensure the tests wont' fail again

jianingwang123 added a commit to jianingwang123/bicep-registry-modules that referenced this pull request Sep 12, 2024
## Description

<!--
>Thank you for your contribution !
> Please include a summary of the change and which issue is fixed.
> Please also include the context.
> List any dependencies that are required for this change.

Fixes Azure#123
Fixes Azure#456
Closes Azure#123
Closes Azure#456
-->
Fixes
[Azure/Azure-Verified-Modules/issues#1232](Azure/Azure-Verified-Modules#1232)
## Pipeline Reference

<!-- Insert your Pipeline Status Badge below -->

| Pipeline |
| -------- |
|
[![avm.ptn.azd.apim-api](https://github.com/jianingwang123/bicep-registry-modules/actions/workflows/avm.ptn.azd.apim-api.yml/badge.svg?branch=apim-api)](https://github.com/jianingwang123/bicep-registry-modules/actions/workflows/avm.ptn.azd.apim-api.yml)
|

## Type of Change

<!-- Use the checkboxes [x] on the options that are relevant. -->

- [ ] Update to CI Environment or utilities (Non-module affecting
changes)
- [x] Azure Verified Module updates:
- [ ] Bugfix containing backwards-compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [ ] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [ ] Breaking changes and I have bumped the MAJOR version in
`version.json`.
  - [ ] Update to documentation

## Checklist

- [x] I'm sure there are no other open Pull Requests for the same
update/change
- [x] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [x] My corresponding pipelines / checks run clean and green without
any errors or warnings

<!-- Please keep up to date with the contribution guide at
https://aka.ms/avm/contribute/bicep -->
@jongio for notification.
@jianingwang123
Copy link
Contributor Author

jianingwang123 commented Sep 12, 2024

Hey @jianingwang123, please note that the module publishing failed because the static test failed. As per the error, it seems the generated files where to up to date when merging the PR. To solve this we need a few things:

  1. You need to create a new PR based on the latest code in main
  2. In that PR you need to introduce a change to the main.json file. It does not matter what it is (e.g., it can be a change to the module's description or a parameter), but it must be something that tells the CI 'hey something that justifies a new module version changed'
  3. You need to run the Set-AVMModule script again to make sure the files are up to date
  4. You ideally also run the pipeline again so that we can ensure the tests wont' fail again

@AlexanderSehr The PR for it is ready. Please help review.

AlexanderSehr pushed a commit that referenced this pull request Sep 12, 2024
… `azd/apim-api` (#3256)

## Description
Fixes
[comment](#3206 (comment))
adout static test failed of ptn modules `azd/apim-api`.
<!--
>Thank you for your contribution !
> Please include a summary of the change and which issue is fixed.
> Please also include the context.
> List any dependencies that are required for this change.

Fixes #123
Fixes #456
Closes #123
Closes #456
-->

## Pipeline Reference

<!-- Insert your Pipeline Status Badge below -->

| Pipeline |
| -------- |
|
[![avm.ptn.azd.apim-api](https://github.com/jianingwang123/bicep-registry-modules/actions/workflows/avm.ptn.azd.apim-api.yml/badge.svg?branch=fix%2Fnew)](https://github.com/jianingwang123/bicep-registry-modules/actions/workflows/avm.ptn.azd.apim-api.yml)
|

## Type of Change

<!-- Use the checkboxes [x] on the options that are relevant. -->

- [ ] Update to CI Environment or utilities (Non-module affecting
changes)
- [x] Azure Verified Module updates:
- [ ] Bugfix containing backwards-compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [ ] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [ ] Breaking changes and I have bumped the MAJOR version in
`version.json`.
  - [ ] Update to documentation

## Checklist

- [x] I'm sure there are no other open Pull Requests for the same
update/change
- [x] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [x] My corresponding pipelines / checks run clean and green without
any errors or warnings

<!-- Please keep up to date with the contribution guide at
https://aka.ms/avm/contribute/bicep -->
@jongio for notification.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AZD 🧑‍💻 These modules are requested/used by the AZD team. Needs: Core Team 🧞 This item needs the AVM Core Team to review it Needs: Triage 🔍 Maintainers need to triage still Type: AVM 🅰️ ✌️ Ⓜ️ This is an AVM related issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Module Proposal]: avm/ptn/azd/apim-api
4 participants