fix: App job documentation updates - avm/res/app/job
#2074
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…g change on secrets!
microsoft-github-policy-service
bot
added
Needs: Triage 🔍
segraef
changed the title
segraef
changed the title
avm/res/app/job
eriqua
added
Class: Resource Module 📦
eriqua
reviewed
May 29, 2024
1 task
eriqua
reviewed
May 31, 2024
eriqua
reviewed
May 31, 2024
eriqua
reviewed
May 31, 2024
eriqua
reviewed
May 31, 2024
|
Hey @ReneHezser, |
hundredacres
pushed a commit
to hundredacres/bicep-registry-modules
that referenced
this pull request
Jun 19, 2024
## Description
- changed secure parameter from an as secure decorated object to a
custom type.
- improved documentation with examples and tests
Unfortunately, there is a breaking change in this change. The secrets
parameter required a `secureList` property, which is not required
anymore
```
// this is the old usage
secrets: {
secureList: [
{
name: 'connection-string'
value: '<secretValue>'
}
]
}
// which has now changed to a custom type and must be used like this:
secrets: [
{
name: 'connection-string'
value: '<secretValue>'
}
]
```
Azure#2070
Fixes Azure#2071
## Pipeline Reference
<!-- Insert your Pipeline Status Badge below -->
| Pipeline |
| -------- |
|
[](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.app.job.yml)
|
## Type of Change
<!-- Use the check-boxes [x] on the options that are relevant. -->
- [ ] Update to CI Environment or utlities (Non-module effecting
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`.
- [x] Breaking changes and I have bumped the MAJOR version in
`version.json`.
- [x] 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
---------
Co-authored-by: Alexander Sehr <[email protected]>
](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.app.job.yml){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Unfortunately, there is a breaking change in this change. The secrets parameter required a
secureListproperty, which is not required anymore#2070
Fixes #2071
Pipeline Reference
Type of Change
version.json:version.json.version.json.Checklist
Set-AVMModulelocally to generate the supporting module files.