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 version if work in fort #427

Merged
merged 1 commit into from
Oct 18, 2024

Conversation

klinch0
Copy link
Contributor

@klinch0 klinch0 commented Oct 15, 2024

if i work in fork, i see error:

klin@asus:~/gumilev/cozystack/packages/core/installer$ make image-cozystack REGISTRY=kklinch0
make -C ../../.. repos
make[1]: Entering directory '/home/klin/gumilev/cozystack'
rm -rf _out
make -C packages/apps check-version-map
make[2]: Entering directory '/home/klin/gumilev/cozystack/packages/apps'
find . -maxdepth 2 -name Chart.yaml  | awk -F/ '{print $2}' | while read i; do sed -i "s/^name: .*/name: $i/" "$i/Chart.yaml"; done
../../hack/gen_versions_map.sh
git diff --exit-code -- versions_map
make[2]: Leaving directory '/home/klin/gumilev/cozystack/packages/apps'
make -C packages/extra check-version-map
make[2]: Entering directory '/home/klin/gumilev/cozystack/packages/extra'
find . -maxdepth 2 -name Chart.yaml | awk -F/ '{print $2}' | while read i; do sed -i "s/^name: .*/name: $i/" "$i/Chart.yaml"; done
../../hack/gen_versions_map.sh
git diff --exit-code -- versions_map
make[2]: Leaving directory '/home/klin/gumilev/cozystack/packages/extra'
make -C packages/system repo
make[2]: Entering directory '/home/klin/gumilev/cozystack/packages/system'
fatal: No names found, cannot describe anything.
rm -rf "../../_out/repos/system"
mkdir -p "../../_out/repos/system"
helm package -d "../../_out/repos/system" $(find . -mindepth 2 -maxdepth 2 -name Chart.yaml | awk 'sub("/Chart.yaml", "")') --version 
WARNING: Kubernetes configuration file is group-readable. This is insecure. Location: /home/klin/.kube/config
WARNING: Kubernetes configuration file is world-readable. This is insecure. Location: /home/klin/.kube/config
Error: flag needs an argument: --version
make[2]: *** [Makefile:8: repo] Error 1
make[2]: Leaving directory '/home/klin/gumilev/cozystack/packages/system'
make[1]: *** [Makefile:26: repos] Error 2
make[1]: Leaving directory '/home/klin/gumilev/cozystack'
make: *** [Makefile:26: image-cozystack] Error 

so as not to cause unnecessary difficulties when trying to find the problem, I suggest this crutch

Summary by CodeRabbit

  • New Features

    • Enhanced script functionality to automatically retrieve the latest version tag when not defined.
  • Bug Fixes

    • Improved handling of the VERSION variable to ensure it is populated correctly.

@klinch0 klinch0 requested a review from kvaps as a code owner October 15, 2024 18:16
Copy link
Contributor

coderabbitai bot commented Oct 15, 2024

Walkthrough

The changes introduce a conditional block in the scripts/common-envs.mk file that checks if the VERSION variable is empty. If it is not set, the script adds a remote repository named upstream pointing to a specific GitHub repository, fetches tags from this remote, and updates the VERSION variable by extracting the latest tag using git describe. This allows for automatic retrieval of the latest version tag when none is defined.

Changes

File Change Summary
scripts/common-envs.mk Added a conditional block to check if VERSION is empty; if so, adds upstream remote, fetches tags, and updates VERSION with the latest tag.

Poem

In the script where versions roam,
A rabbit found a way to comb,
If VERSION is empty, oh what a sight,
Fetching tags from the GitHub light!
With upstream now in play,
The latest version comes to stay! 🐇✨


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.

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: 0

🧹 Outside diff range and nitpick comments (1)
scripts/common-envs.mk (1)

12-16: Clever workaround, but consider potential improvements

This change addresses the issue of missing version information when working in a fork, which is great. However, there are a few considerations:

  1. Modifying the git configuration might not be ideal in all environments.
  2. The solution assumes the upstream repository always has tags and is accessible.
  3. Fetching tags could slow down the build process on slow networks.
  4. The hardcoded URL might pose a security risk if repository ownership changes.

Consider the following improvements:

  1. Make the upstream URL configurable via an environment variable.
  2. Add error handling for network issues or missing tags.
  3. Implement a caching mechanism to avoid frequent remote fetches.
  4. Add a comment explaining this workaround for future maintainers.

Here's a suggested improvement:

+# Fallback URL for upstream repository (can be overridden by environment variable)
+UPSTREAM_URL ?= https://github.com/aenix-io/cozystack.git

 ifeq ($(VERSION),)
-    $(shell git remote add upstream https://github.com/aenix-io/cozystack.git || true)
-    $(shell git fetch upstream --tags)
-    VERSION = $(patsubst v%,%,$(shell git describe --tags --abbrev=0))
+    # Fallback mechanism to fetch version from upstream when working in a fork
+    $(shell git remote add upstream $(UPSTREAM_URL) 2>/dev/null || git remote set-url upstream $(UPSTREAM_URL) 2>/dev/null)
+    $(shell git fetch upstream --tags --quiet)
+    VERSION = $(patsubst v%,%,$(shell git describe --tags --abbrev=0 2>/dev/null || echo "0.0.0"))
 endif

This change allows for a configurable upstream URL, handles potential errors more gracefully, and provides a default version if no tags are found.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2e16f78 and 6055de8.

📒 Files selected for processing (1)
  • scripts/common-envs.mk (1 hunks)
🧰 Additional context used

@kvaps kvaps merged commit f3b9843 into aenix-io:main Oct 18, 2024
1 check passed
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.

2 participants