Updated to build new way

mitchelsellers commented 1 month ago

Fixes #81

Summary by CodeRabbit

New Features
- Enhanced version management in CI workflows with updated GitVersion actions for improved reliability and consistency.
- Introduced new versioning configuration options for better control over version increments based on commit tagging.
Bug Fixes
- Upgraded GitVersion actions may include various improvements and bug fixes relevant to versioning processes.
Documentation
- Updated terminology in versioning configuration for clarity, including renaming 'tag' to 'label' and refining related properties.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes involve updates to the CI workflow files and the GitVersion configuration. The installation and execution methods for GitVersion have been switched to use the GitHub Actions gittools/actions/gitversion/setup@v3.0.0 and gittools/actions/gitversion/execute@v3.0.0, replacing the previous command-line installation. Additionally, the GitVersion.yml file has undergone terminology changes, including renaming tag to label and introducing a new property to prevent version increments under certain conditions.

Changes

Files	Change Summary
`.github/workflows/ci-build.yml`	Updated GitVersion installation and execution to `v3.0.0`, replacing command-line installation.
`.github/workflows/release-build.yml`	Updated GitVersion installation and execution to `v3.0.0`, replacing command-line installation.
`GitVersion.yml`	Renamed `tag` to `label`, added `prevent-increment`, and renamed `tag-number-pattern` to `label-number-pattern`.

Assessment against linked issues

Objective	Addressed	Explanation
Change `tag` to `label`	✅
Change `tag-number-pattern` to `label-number-pattern`	✅
Add `prevent-increment` to the `develop` branch rules	✅
Update GitVersion installation and execution to `v3.0.0`	✅

Poem

🐰 In the meadow where the code does play,
New versions hop in, brightening the day.
Labels replace tags, a fresh little twist,
Preventing increments, a change not to miss!
With GitVersion now set, our builds will be grand,
Hopping along, with a versioning plan! 🌼

Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 752f105d5e03a707e4e3def8609fbb011316f712 and a9a75d88909c9fe8027f1287752e122079754912.

Files selected for processing (3)

* .github/workflows/ci-build.yml (2 hunks) * .github/workflows/release-build.yml (1 hunks) * GitVersion.yml (1 hunks)

Additional comments not posted (8)

GitVersion.yml (4)
`6-6`: **LGTM!** The change from `tag` to `label` for the `develop` branch aligns with the PR objective and is approved. --- `8-9`: **LGTM!** The addition of the `prevent-increment` property to prevent version increments when the current commit is tagged aligns with the PR objective and is approved. --- `13-13`: **LGTM!** The change from `tag` to `label` for the `pull-request` branch aligns with the PR objective and is approved. --- `14-14`: **LGTM!** The change from `tag-number-pattern` to `label-number-pattern` for the `pull-request` branch aligns with the PR objective and is approved.

.github/workflows/release-build.yml (2)
`26-28`: **LGTM!** The changes to the GitVersion installation step align with the PR objectives. Using the dedicated `gittools/actions/gitversion/setup` action with a version spec of `6.x` enhances the reliability and consistency of the installation process. --- `32-34`: **LGTM, but verify the configuration file.** The upgrade to the `gittools/actions/gitversion/execute` action aligns with the PR objectives and may bring improvements or new features. However, please ensure that the GitVersion configuration file (if used) has been updated to match the new version's requirements. You can use the following script to search for the GitVersion configuration file and verify its contents:

.github/workflows/ci-build.yml (2)
`27-29`: **LGTM!** The code changes correctly implement the required updates to the GitVersion installation method as per the PR objectives. Using the GitHub Action `gittools/actions/gitversion/setup@v3.0.0` with the version spec `6.x` enhances consistency and reliability compared to the previous command-line installation method. --- `33-36`: **LGTM!** The code changes correctly implement the required update to the GitVersion execution action as per the PR objectives. Upgrading to `gittools/actions/gitversion/execute@v3.0.0` may include improvements and bug fixes relevant to the versioning process. The `useConfigFile` option remains unchanged, ensuring that the existing configuration file is still utilized.

--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.