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: use Default .SemVer when git version tag property is not calculable #53

Merged

Conversation

mrsauravsahu
Copy link
Owner

@mrsauravsahu mrsauravsahu commented Apr 2, 2024

Summary by CodeRabbit

  • Bug Fixes
    • Ensured consistent handling of GITVERSION_TAG_PROPERTY in versioning script, fixing issues with service version retrieval when the property is unset.

Copy link

coderabbitai bot commented Apr 2, 2024

Walkthrough

This update focuses on refining the versioning process within the semver-yeasy.sh script by ensuring the GITVERSION_TAG_PROPERTY is consistently handled. This involves setting a default value for this property when it's not specified, streamlining the version retrieval for service_version, and enhancing the overall reliability and predictability of the versioning system.

Changes

Files Change Summary
apps/.../semver-yeasy.sh Defaulted GITVERSION_TAG_PROPERTY to maintain version consistency

Possibly related issues

Poem

In the code's vast, verdant field, 🌱
A rabbit hopped, its fate sealed,
To versions far and wide it leaped,
In semver-yeasy.sh, secrets it peeped.
With a tweak, a twist, and a merry cheer, 🎉
"To consistent versions, we draw near!"
In the glow of the moon, it danced away, 🌕
Leaving behind a brighter day.

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

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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/coderabbit-overrides.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.

@mrsauravsahu mrsauravsahu merged commit 4beabf5 into main Apr 2, 2024
0 of 2 checks passed
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: 4

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 9dab8d7 and 87bf605.
Files selected for processing (1)
  • apps/semver-yeasy/semver-yeasy.sh (4 hunks)
Additional comments not posted (2)
apps/semver-yeasy/semver-yeasy.sh (2)

96-102: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [9-15]

Several GITVERSION_TAG_PROPERTY_* and GITVERSION_CONFIG_SINGLE_APP variables appear unused. Verify their usage or export them if they are used externally.


99-99: Setting GITVERSION_TAG_PROPERTY to a default value when it's empty is a crucial fix. However, ensure that the logic for determining the property name and its assignment is consistent and error-free across the script.

Also applies to: 131-131, 186-186, 213-213

Comment on lines 96 to 102
GITVERSION_TAG_PROPERTY=${!GITVERSION_TAG_PROPERTY_NAME}

if [ "${GITVERSION_TAG_PROPERTY}" == "" ]; then
GITVERSION_TAG_PROPERTY_NAME="GITVERSION_TAG_PROPERTY_DEFAULT"
GITVERSION_TAG_PROPERTY=${GITVERSION_TAG_PROPERTY_DEFAULT}
fi

service_version=$(echo "${gitversion_calc}" | ${JQ_EXEC_PATH} -r "[${GITVERSION_TAG_PROPERTY}] | join(\"\")")
Copy link

Choose a reason for hiding this comment

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

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [6-6]

The use of tr with square brackets around classes is unnecessary and can be simplified. Also, consider wrapping $2 in double quotes to prevent globbing and word splitting.

- repo_type="$(echo $2 | tr '[[:lower:]]' '[[:upper:]]')"
+ repo_type="$(echo "$2" | tr '[:lower:]' '[:upper:]')"

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [22-22]

Consider wrapping $GITHUB_OUTPUT in double quotes to prevent globbing and word splitting.

- echo "$@" >> $GITHUB_OUTPUT
+ echo "$@" >> "$GITHUB_OUTPUT"

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [66-66]

When assigning arrays from command outputs, prefer using mapfile or read -a to avoid issues with word splitting and to handle non-alphanumeric filenames more robustly.

- changed_services=(`ls -1 apps | xargs -n 1 printf 'apps/%s\n'`)
+ mapfile -t changed_services < <(ls -1 apps | xargs -n 1 printf 'apps/%s\n')

For the git diff command output parsing, consider a similar approach or ensure proper quoting.

Also applies to: 75-75, 77-77


📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [95-95]

In several places, the script uses tr with unnecessary square brackets around classes. Simplify these expressions by removing the square brackets.

- GITVERSION_TAG_PROPERTY_NAME="GITVERSION_TAG_PROPERTY_$(echo "${DIFF_SOURCE}" | sed 's|/.*$||' | tr '[[:lower:]]' '[[:upper:]]')"
+ GITVERSION_TAG_PROPERTY_NAME="GITVERSION_TAG_PROPERTY_$(echo "${DIFF_SOURCE}" | sed 's|/.*$||' | tr '[:lower:]' '[:upper:]')"

Also applies to: 128-128, 182-182, 209-209

@mrsauravsahu mrsauravsahu deleted the fix/50-version-calc-during-push-events-with-event branch April 2, 2024 16:19
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.

None yet

1 participant