ci: Use alpha suffix for NuGet pre-release in test environment

[oskogstad]

Co-authored-by: Magnus Sandgren 5285192+MagnusSandgren@users.noreply.github.com
Co-authored-by: Are Almaas arealmaas@gmail.com
Co-authored-by: Amund Myrbostad Lullinj98@gmail.com

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates two CI/CD workflow files. In the main workflow, formatting is enhanced, and a new job generate-timestamp is introduced to generate a timestamp that modifies the version format in the publish-sdk-to-nuget job. In the staging workflow, a new job generate-git-short-sha is added, and the publish-sdk-to-nuget job is updated to depend on it and adjust its version parameter accordingly.

Changes

File	Change Summary
.github/workflows/ci-cd-main.yml	- Adjusted formatting (added spaces in branches and needs fields). - Added new job generate-timestamp to generate and output a timestamp. - Updated publish-sdk-to-nuget job: added generate-timestamp in dependencies and changed version format from -rc. to -alpha. using the timestamp and Git short SHA.
.github/workflows/ci-cd-staging.yml	- Added new job generate-git-short-sha (positioned before the get-versions-from-github job). - Updated publish-sdk-to-nuget job: included generate-git-short-sha in dependencies and modified the version parameter to append the Git short SHA output.

Possibly related PRs

• ci: updated NuGet version strategy #1948: Modifies the versioning format in the publish-sdk-to-nuget job by switching from -rc to -alpha and appending the Git short SHA.
• feat: push WebApi SDK to NuGet #1916: Involves modifications to the publish-sdk-to-nuget job's dependencies and versioning scheme, similar to this PR.
• chore: updated push sdk to NuGet workflow on WebApiClient changes #1944: Updates dependency lists and versioning logic in the publish-sdk-to-nuget job, correlating with the changes in this PR.

Suggested reviewers

• MagnusSandgren

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 736a468 and bf38293.

📒 Files selected for processing (1)

• .github/workflows/ci-cd-main.yml (5 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• .github/workflows/ci-cd-main.yml

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Dry run deploy infrastructure / Deploy to test
• GitHub Check: build / build-and-test

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

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

88-92: Staging Publish Job Version Suffix Update
The update to the publish-sdk-to-nuget job now includes the new dependency (generate-git-short-sha) and appropriately appends the Git short SHA to the version string (-rc+${{ needs.generate-git-short-sha.outputs.gitShortSha }}). Please verify that using the -rc suffix here is intentional for the staging environment, especially as the PR objective targets an alpha suffix for test releases. A clarifying comment could help prevent confusion.

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

101-110: Timestamp Generation for Test Environment Versioning
The new generate-timestamp job is implemented succinctly and outputs a timestamp that is used later in versioning. One suggestion is to consider whether a UTC or ISO 8601 format might add clarity and consistency in chronological sorting for future releases. Otherwise, the current approach works.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3782149 and 736a468.

📒 Files selected for processing (2)

• .github/workflows/ci-cd-main.yml (5 hunks)
• .github/workflows/ci-cd-staging.yml (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Dry run deploy apps / Deploy job sync-resource-policy-information-job to test
• GitHub Check: Dry run deploy apps / Deploy job sync-subject-resource-mappings-job to test

🔇 Additional comments (2)

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

13-16: New Job for Git Short SHA Generation
The addition of the generate-git-short-sha job is clear and well integrated. The use of the reusable workflow via uses: ./.github/workflows/workflow-generate-git-short-sha.yml makes the configuration modular.

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

112-117: Publish SDK to NuGet Job Version Update – Using Alpha Suffix
The modifications in the publish-sdk-to-nuget job properly include the new dependency on generate-timestamp and update the version string to:

${{ needs.get-current-version.outputs.version }}-alpha.${{ needs.generate-timestamp.outputs.timestamp }}+${{ needs.generate-git-short-sha.outputs.gitShortSha }}

This aligns with the PR objective to use an alpha suffix for NuGet pre-release versions in the test environment. The changes appear correct and maintain consistency with the intended version schema.