DDST-1041: Add semver tagging workflow

[nchiasson-dgi]

Summary by CodeRabbit

• Chores
  • Implemented an automated versioning mechanism that activates upon merging approved changes. This new process calculates and applies semantic versioning, including proper major release tagging. By reducing manual intervention, this update ensures release tags accurately reflect the scope of updates, thereby facilitating smoother release management and offering users consistently reliable version information.

[coderabbitai]

Walkthrough

A new GitHub Actions workflow file (semver.yml) has been added. This workflow triggers on closed pull requests targeting the main branch when they are merged. It defines a job named update that runs on an Ubuntu environment. The job consists of two steps: one to automatically determine and apply semantic versioning using the discoverygarden/auto-semver@v1 action, and another to update the major version tag with a prefix of 'v' using the discoverygarden/action-major-tag@v1 action.

Changes

File	Summary
.github/workflows/semver.yml	New GitHub Actions workflow triggered on merged pull requests to the main branch. Contains an "update" job on Ubuntu with two steps: semantic versioning and major tag update.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant GH as GitHub
    participant WS as Workflow (semver.yml)
    participant AS as AutoSemver Action
    participant MT as Major Tag Action

    U->>GH: Merge PR targeting main
    GH->>WS: Trigger workflow on closed PR (merged)
    WS->>AS: Execute auto-semver step
    AS-->>WS: Return computed semantic version
    WS->>MT: Execute major tag update (prefix: "v")
    MT-->>WS: Return updated major tag

Loading

Poem

I'm a happy rabbit, with a skip and a hop,
New workflows jump in, and they'll never stop.
Auto semver and tags, all in one neat run,
Coding magic in CI, oh what fun!
With carrots of code, we cheerfully update—hip, hop, and relate!
🥕✨ Hop along to a versioning state!

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)

• JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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 (1)

.github/workflows/semver.yml (1)

3-7: Workflow Trigger Configuration
The workflow is configured to trigger on pull_request_target events for closed pull requests on the main branch, which aligns with the PR objective of running semver tagging only when pull requests are merged. If the use of pull_request_target is intentional for finer-grained permissions (especially regarding secret access), consider adding a short comment to document this design decision for future maintainers.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 368cb42 and 574d25b.

📒 Files selected for processing (1)

• .github/workflows/semver.yml (1 hunks)

🔇 Additional comments (4)

.github/workflows/semver.yml (4)

1-2: Workflow Header and Name
The YAML header and workflow name ("Auto Semver") are correctly defined.

---

8-12: Job Definition and Conditional Execution
The job update is set up correctly with the conditional if: github.event.pull_request.merged == true, ensuring that the semantic version update runs only when a pull request is merged. This prevents unnecessary executions on PR closures that aren’t merges.

---

13-14: Auto Semver Action Step
The step that uses discoverygarden/auto-semver@v1 is correctly implemented to automatically determine and apply the semantic version based on the merged changes.

---

15-19: Major Tag Update Action Step
The step using discoverygarden/action-major-tag@v1 with the input prefix: 'v' properly configures the workflow to update the major version tag as intended.