ci: include env and version in dispatches #1459
Conversation
📝 WalkthroughWalkthroughThe pull request introduces updates to two GitHub workflow files: Changes
Possibly related PRs
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
.github/workflows/dispatch-apps.yml (2)
43-43: LGTM! Consistent and descriptive job naming.The updated job name improves clarity by including the version information. This aligns well with the run-name format and enhances overall workflow visibility.
Consider applying this naming pattern consistently across all deployment workflows in the repository for uniformity.
Line range hint
19-23: Add documentation for the runMigration parameter.While the parameter is well-defined, it would be helpful to add documentation explaining:
- When should migrations be run?
- What are the implications of enabling/disabling migrations?
- Are there any prerequisites or considerations when running migrations?
Consider adding these details in a comment above the parameter or in the workflow documentation.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
.github/workflows/dispatch-apps.yml(2 hunks).github/workflows/dispatch-infrastructure.yml(2 hunks)
🔇 Additional comments (4)
.github/workflows/dispatch-infrastructure.yml (3)
21-21: LGTM! Clear and informative run name format.
The addition of run-name with environment and version information improves workflow visibility and aligns well with the PR objectives.
32-32: LGTM! Job name clearly indicates deployment context.
The updated job name format with environment and version in parentheses improves clarity and maintains consistency with the workflow's run name.
Line range hint 21-32: Verify consistency across workflow files.
Let's ensure the naming convention is consistent across all workflow files and that there are no broken references.
✅ Verification successful
Naming conventions and workflow references are consistent
The verification shows:
- Run-name patterns are consistent across dispatch workflows, following the format
Dispatch <type> <environment> v<version> - Deploy job names follow a consistent pattern:
Deploy <type> to <environment> (v<version>) - The workflow is correctly referenced in CI/CD workflows (ci-cd-*.yml)
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for consistency in workflow naming patterns and potential references
# Check for run-name and job name patterns in other workflow files
echo "Checking for run-name and job name patterns in workflow files..."
fd -e yml -e yaml . .github/workflows/ --exec rg -l "run-name:|name: Deploy.*to.*\(\s*v.*\)"
# Look for potential workflow references that might need updates
echo "Checking for workflow references..."
rg -l "uses: \.\/\.github\/workflows\/(dispatch-infrastructure|workflow-deploy-infra)\.yml" .github/workflows/
Length of output: 713
Script:
#!/bin/bash
# Let's fix the regex and check workflow references properly
echo "Checking workflow references..."
rg -l "uses: \\./.github/workflows/(dispatch-infrastructure|workflow-deploy-infra).yml" .github/workflows/
# Let's examine the run-name and job naming patterns in detail
echo -e "\nChecking run-name patterns in workflows..."
rg "run-name:" -A 1 .github/workflows/dispatch-*.yml
echo -e "\nChecking deploy job names in workflows..."
rg "name: Deploy" -A 1 .github/workflows/dispatch-*.yml
Length of output: 1914
.github/workflows/dispatch-apps.yml (1)
27-28: LGTM! Clear and informative run name.
The addition of a dynamic run-name that includes both environment and version improves workflow visibility and directly addresses the PR objective.
Description
To make it more clear what version is deployed to what environment.
The overview now is not that descriptive..
Related Issue(s)
Verification
Documentation
docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)Summary by CodeRabbit