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

ci: updated NuGet version strategy #1948

Closed
wants to merge 3 commits into from

Conversation

Fargekritt
Copy link
Contributor

Description

Dev: {major}.{minor}.{patch}.{revision}-alpha+{gitsha}
Stage: {major}.{minor}.{patch}.{revision}-rc+{gitsha}
Prod: {major}.{minor}.{patch}.{revision}

Related Issue(s)

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

  • Documentation is updated (either in docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)

@Fargekritt Fargekritt requested review from a team as code owners February 24, 2025 11:39
Copy link
Contributor

coderabbitai bot commented Feb 24, 2025

Warning

Rate limit exceeded

@Fargekritt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 0 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 34bb1ed and 0dfc7d7.

📒 Files selected for processing (1)
  • .github/workflows/ci-cd-staging.yml (2 hunks)
📝 Walkthrough

Walkthrough

This pull request updates the version formatting for the publish-sdk-to-nuget job in two CI/CD workflow files. In the main workflow file, the version string is changed from a release candidate format to an alpha format, including a change in delimiter. In the staging workflow file, the version string now appends a Git short SHA to the release candidate version. No changes were made to the declarations of exported or public entities.

Changes

File(s) Change Summary
.github/workflows/ci-cd-main.yml
.github/workflows/ci-cd-staging.yml
Modified the versioning for the publish-sdk-to-nuget job: In the main workflow, updated from a release candidate (-rc) to an alpha (-alpha+) designation; in the staging workflow, appended a Git short SHA to the release candidate version string.

Possibly related PRs

Suggested reviewers

  • oskogstad
  • MagnusSandgren

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
🪧 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 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 34bb1ed.

📒 Files selected for processing (2)
  • .github/workflows/ci-cd-main.yml (1 hunks)
  • .github/workflows/ci-cd-staging.yml (1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/ci-cd-staging.yml

87-87: property "generate-git-short-sha" is not defined in object type {check-for-changes: {outputs: {hasbackendchanges: string; hasgqlschemachanges: string; hasinfrachanges: string; hasmigrationchanges: string; hasslacknotifierchanges: string; hasswaggerschemachanges: string; hastestchanges: string; haswebapiclientchanges: string}; result: string}; deploy-apps: {outputs: {deployment_executed: string}; result: string}}

(expression)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Dry run deploy infrastructure / Deploy to test
🔇 Additional comments (1)
.github/workflows/ci-cd-main.yml (1)

106-108: Approved: Updated version string for NuGet publication
The version string has been updated to include the -alpha pre-release identifier along with the Git short SHA, which aligns with the new NuGet versioning strategy for the primary environment. Ensure that any documentation or downstream tooling referencing version formats is updated accordingly.

Comment on lines +87 to 89
version: ${{ github.event.client_payload.version }}-rc+${{ needs.generate-git-short-sha.outputs.gitShortSha }}
path: 'src/Digdir.Library.Dialogporten.WebApiClient/Digdir.Library.Dialogporten.WebApiClient.csproj'
source: 'https://api.nuget.org/v3/index.json'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Critical: Missing dependency for git short SHA output
The updated version string now includes a reference to needs.generate-git-short-sha.outputs.gitShortSha. However, the publish-sdk-to-nuget job’s needs array does not include a job named generate-git-short-sha, which will cause an undefined output error at runtime. Please update the needs list to include the generate-git-short-sha job if it exists, or adjust the reference accordingly.

Suggested diff:

-    needs: [ deploy-apps, check-for-changes ]
+    needs: [ deploy-apps, check-for-changes, generate-git-short-sha ]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
version: ${{ github.event.client_payload.version }}-rc+${{ needs.generate-git-short-sha.outputs.gitShortSha }}
path: 'src/Digdir.Library.Dialogporten.WebApiClient/Digdir.Library.Dialogporten.WebApiClient.csproj'
source: 'https://api.nuget.org/v3/index.json'
jobs:
publish-sdk-to-nuget:
- needs: [ deploy-apps, check-for-changes ]
+ needs: [ deploy-apps, check-for-changes, generate-git-short-sha ]
runs-on: ubuntu-latest
steps:
- name: Publish to NuGet
with:
version: ${{ github.event.client_payload.version }}-rc+${{ needs.generate-git-short-sha.outputs.gitShortSha }}
path: 'src/Digdir.Library.Dialogporten.WebApiClient/Digdir.Library.Dialogporten.WebApiClient.csproj'
source: 'https://api.nuget.org/v3/index.json'
🧰 Tools
🪛 actionlint (1.7.4)

87-87: property "generate-git-short-sha" is not defined in object type {check-for-changes: {outputs: {hasbackendchanges: string; hasgqlschemachanges: string; hasinfrachanges: string; hasmigrationchanges: string; hasslacknotifierchanges: string; hasswaggerschemachanges: string; hastestchanges: string; haswebapiclientchanges: string}; result: string}; deploy-apps: {outputs: {deployment_executed: string}; result: string}}

(expression)

@Fargekritt Fargekritt changed the title chore: updated NuGet version strategy ci: updated NuGet version strategy Feb 24, 2025
@Fargekritt Fargekritt closed this Feb 24, 2025
@Fargekritt Fargekritt deleted the chore/update-nuget-ver-stratergy branch February 24, 2025 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant