chore(ci/cd): Whitespace cleanup [no ci]

[oskogstad]

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced new jobs in CI/CD workflow for dry-run and actual deployments of applications, enhancing deployment processes and error handling.

• Bug Fixes

  • Improved error handling and user feedback in scripts, ensuring better clarity for command-line arguments and job execution statuses.

• Documentation

  • Added comments and improved formatting for clarity in various scripts and Bicep modules.

• Refactor

  • Enhanced readability and maintainability through consistent formatting adjustments across multiple scripts and workflow configurations.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request introduces modifications across several Bicep files and GitHub workflows. Key changes include updates to the tags in the availabilityTest resource, enhancements to secret copying logic in the Key Vault module, formatting adjustments in various scripts, and the addition of new jobs in the CI/CD workflow for application deployments. The changes primarily focus on improving clarity, maintainability, and error handling without altering the fundamental functionality of the resources or scripts involved.

Changes

File Path	Change Summary
.azure/modules/applicationInsights/availabilityTest.bicep	Updated tags syntax in availabilityTest resource to include a specific hidden link tag referencing appInsightsId.
.azure/modules/keyvault/copySecrets.bicep	Added comments, introduced filteredKeysBySecretPrefix variable for filtering keys, and updated parameters for secrets and appConfiguration modules.
.azure/modules/managedIdentity/main.bicep	Updated output declaration for managedIdentityPrincipalId with a formatting adjustment, no functional change.
.azure/modules/monitor-workspace/addMetricsPublisherRoles.bicep	Adjusted closing bracket formatting for roleAssignment resource definition, no functional change.
.azure/modules/serviceBus/main.bicep	Reformatted comments for consistency; no changes to resource definitions or logic.
.github/pr-title-checker-config.json	Added a newline at the end of the file; no changes to the configuration structure.
.github/tools/containerAppJobVerifier.sh	Improved readability with blank lines and consistent formatting in echo statements; control flow remains unchanged.
.github/tools/pwdGenerator.ps1	Reformatted Scramble-String function for consistency; no changes to logic or functionality.
.github/tools/revisionVerifier.sh	Added error handling for command-line arguments and enhanced user feedback; overall functionality preserved.
.github/workflows/ci-cd-prod.yml	Added jobs for dry-run-deploy-apps, deploy-apps, store-apps-version, and send-slack-message-on-failure to enhance deployment processes and error handling.
.github/workflows/workflow-run-k6-performance.yml	Adjusted input definitions for apiVersion and tokens to remove trailing spaces; no functional changes.
.github/workflows/workflow-run-k6-tests.yml	Reformatted apiVersion and TOKEN_GENERATOR_PASSWORD declarations for consistency; no functional changes.

Possibly related PRs

• ci: ensure unique revisions for deployments #1211: Ensures unique revisions for deployments, potentially affected by changes in the availability test resource tags.
• feat(service): deploy application in container apps #1303: Introduces a user-assigned identity for container apps, relevant to tagging and identity management aspects.
• ci: ensure we store the versions as gh variables #1405: Focuses on storing version information as GitHub variables, related to resource tagging and deployment configurations.
• ci: ensure version is stored when deploying apps #1481: Addresses storage of version information during app deployments, directly related to tagging changes.
• feat(azure): connect cae to azure monitor #1486: Connects the CAE to Azure Monitor, involving similar resource management and tagging strategies.

Suggested reviewers

• knuhau

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

.azure/modules/keyvault/copySecrets.bicep (1)

Line range hint 1-77: ⚠️ Functional changes detected in what should be a whitespace cleanup PR

This file contains significant functional changes including:

• Introduction of new variable filteredKeysBySecretPrefix
• Changes to secret filtering logic
• Modifications to module parameters

These changes go beyond the scope of whitespace cleanup indicated in the PR title "chore(ci/cd): Whitespace cleanup".

Please either:

1. Update the PR title and description to reflect these functional changes, or
2. Create a separate PR for these functional modifications to ensure proper review focus

.github/workflows/ci-cd-prod.yml (1)

Line range hint 32-177: ⚠️ Substantial workflow changes detected in what should be a whitespace cleanup PR

This file contains significant functional changes including:

• Addition of new jobs (dry-run-deploy-apps, deploy-apps, store-apps-version)
• New deployment logic and conditions
• Enhanced error handling with Slack notifications

These changes go beyond the scope of whitespace cleanup indicated in the PR title "chore(ci/cd): Whitespace cleanup".

Please either:

1. Update the PR title and description to reflect these functional changes, or
2. Create a separate PR for these functional modifications to ensure:
   • Proper review focus on the deployment changes
   • Appropriate testing of the new deployment workflow
   • Clear documentation of the workflow modifications

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9c2c876 and 569d267.

📒 Files selected for processing (12)

• .azure/modules/applicationInsights/availabilityTest.bicep (1 hunks)
• .azure/modules/keyvault/copySecrets.bicep (1 hunks)
• .azure/modules/managedIdentity/main.bicep (1 hunks)
• .azure/modules/monitor-workspace/addMetricsPublisherRoles.bicep (1 hunks)
• .azure/modules/serviceBus/main.bicep (1 hunks)
• .github/pr-title-checker-config.json (1 hunks)
• .github/tools/containerAppJobVerifier.sh (2 hunks)
• .github/tools/pwdGenerator.ps1 (1 hunks)
• .github/tools/revisionVerifier.sh (1 hunks)
• .github/workflows/ci-cd-prod.yml (2 hunks)
• .github/workflows/workflow-run-k6-performance.yml (3 hunks)
• .github/workflows/workflow-run-k6-tests.yml (2 hunks)

✅ Files skipped from review due to trivial changes (7)

• .github/pr-title-checker-config.json
• .github/workflows/workflow-run-k6-tests.yml
• .github/tools/pwdGenerator.ps1
• .azure/modules/serviceBus/main.bicep
• .azure/modules/managedIdentity/main.bicep
• .azure/modules/monitor-workspace/addMetricsPublisherRoles.bicep
• .github/workflows/workflow-run-k6-performance.yml

🔇 Additional comments (3)

.azure/modules/applicationInsights/availabilityTest.bicep (1)

25-27: LGTM! Whitespace cleanup only.

The changes are purely formatting-related and maintain the same functionality for tag union operation.

.github/tools/containerAppJobVerifier.sh (1)

34-34: LGTM! Improved readability with consistent spacing.

The added blank lines enhance code readability by properly separating logical blocks within the script.

Also applies to: 41-41, 47-47, 52-52, 74-74

.github/tools/revisionVerifier.sh (1)

61-61: LGTM! Consistent spacing maintained.

The added blank line improves readability by separating the result assignment from the case statement.