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

Fix project and build versions #645

Merged
merged 1 commit into from
Sep 25, 2024
Merged

Conversation

Danielius1922
Copy link
Member

No description provided.

@Danielius1922 Danielius1922 marked this pull request as ready for review September 25, 2024 14:04
Copy link

coderabbitai bot commented Sep 25, 2024

Walkthrough

The changes involve updating the version information for the IoTivity-lite project across multiple files. The project version in CMakeLists.txt has been incremented from 2.2.5.13 to 2.2.5.15. Correspondingly, the build version in include/oc_build_info.h has been updated, with the hexadecimal representation and version string reflecting this new build. Additionally, the port/linux/Makefile has been modified to adopt a more detailed versioning format that includes major, minor, patch, and build numbers, resulting in the same final version of 2.2.5.15.

Changes

File Change Summary
CMakeLists.txt Updated project version from 2.2.5.13 to 2.2.5.15.
include/oc_build_info.h Incremented build version from 13 to 15, updated hexadecimal version from 0x0202050D to 0x0202050F, and changed version string from "2.2.5.13" to "2.2.5.15".
port/linux/Makefile Changed versioning from 1.0 to 2.2.5.15, updated VERSION_MAJOR from 1 to 2, VERSION_MINOR from 0 to 2, added VERSION_PATCH as 5, and added VERSION_BUILD as 15.

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

@ocf-conformance-test-tool
Copy link

🎉 Thank you for your code contribution! To guarantee the change/addition is conformant to the OCF Specification, we would like to ask you to execute OCF Conformance Testing of your change ☝️ when your work is ready to be reviewed.


ℹ️ To verify your latest change (e331753), label this PR with OCF Conformance Testing.

⚠️ Label is removed with every code change.

Copy link

@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

🧹 Outside diff range and nitpick comments (2)
port/linux/Makefile (2)

9-14: LGTM! Consider adding a VERSION_FULL variable.

The new versioning scheme is well-structured and follows semantic versioning principles. It allows for easier management of version components.

Consider adding a VERSION_FULL variable that includes all components, which could be useful for display purposes:

VERSION_FULL = $(VERSION_MAJOR).$(VERSION_MINOR).$(VERSION_PATCH).$(VERSION_BUILD)
VERSION = $(VERSION_MAJOR).$(VERSION_MINOR).$(VERSION_PATCH)

This way, VERSION follows the more common three-component format, while VERSION_FULL includes the build number.


9-14: Summary: Version management improvements

The changes to the Makefile improve version management by breaking down the version into separate components (MAJOR, MINOR, PATCH, BUILD) and providing a clear structure for the VERSION variable. This approach aligns with semantic versioning principles and should make it easier to manage version updates in the future.

Consider the following points:

  1. Ensure that any scripts or processes that rely on the version number are updated to handle the new four-component format.
  2. Update any documentation that references the version number to reflect this new structure.
  3. If there are any release processes or CI/CD pipelines that use this Makefile, make sure they are compatible with the new versioning scheme.

These changes lay a good foundation for more structured version management, which can be beneficial for release tracking and dependency management in the long run.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 980b8fe and e331753.

📒 Files selected for processing (3)
  • CMakeLists.txt (1 hunks)
  • include/oc_build_info.h (1 hunks)
  • port/linux/Makefile (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • CMakeLists.txt
🔇 Additional comments not posted (4)
include/oc_build_info.h (3)

33-33: LGTM: Version build number updated correctly.

The IOTIVITY_LITE_VERSION_BUILD has been incremented from 13 to 15, which is consistent with the PR objectives.


40-40: LGTM: Hexadecimal version number updated correctly.

The IOTIVITY_LITE_VERSION hexadecimal representation has been updated to 0x0202050F, which correctly reflects the new version 2.2.5.15.


41-41: LGTM: Version string updated correctly.

The IOTIVITY_LITE_VERSION_STRING has been updated to "2.2.5.15", which is consistent with the new version number.

port/linux/Makefile (1)

9-14: Verify VERSION usage throughout the Makefile

The VERSION variable has been updated to include all four components (MAJOR.MINOR.PATCH.BUILD). Please ensure that all uses of VERSION throughout the Makefile are still valid with this new format.

Run the following script to check all occurrences of VERSION usage:

If any occurrences are found where the new VERSION format might cause issues, please review and update them accordingly.

✅ Verification successful

VERSION Usage Verified Successfully

All occurrences of the VERSION variable in port/linux/Makefile have been updated correctly and are compatible with the new VERSION format.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check all occurrences of VERSION usage in the Makefile

# Test: Search for VERSION usage
rg '\$\(VERSION\)' port/linux/Makefile

# Test: Search for VERSION assignment
rg '^VERSION\s*=' port/linux/Makefile

Length of output: 257

include/oc_build_info.h Show resolved Hide resolved
Copy link

@Danielius1922 Danielius1922 merged commit 8650644 into master Sep 25, 2024
141 checks passed
@Danielius1922 Danielius1922 deleted the adam/feature/fix-version branch September 25, 2024 15:15
@github-actions github-actions bot locked and limited conversation to collaborators Sep 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant