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(docs): sed syntax fix for GNU sed #579

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Conversation

rajp152k
Copy link
Contributor

the initial command only works for the BSD variant of sed (MacOS..) A syntax error is raised for the GNU variant
need to remove the extra backup '' after -i

on OpenSuse tumbleweed:
Using the initial command gives

 $ sed -i '' 's/karpor-server.karpor.svc/127.0.0.1/g' $HOME/.kube/karpor-hub-cluster.kubeconfig
sed: can't read s/karpor-server.karpor.svc/127.0.0.1/g: No such file or directory

and after the fix, it works

for reference : https://www.baeldung.com/linux/gnu-bsd-stream-editor

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

  • N
  • Y

2. What is the scope of this PR (e.g. component or file name):

user guide docs
https://www.kusionstack.io/karpor/user-guide/how-to-create-token

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Other

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

  • N
  • Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

  • Unit test
  • Integration test
  • Benchmark (add benchmark stats below)
  • Manual test (add detailed scripts or steps below)
  • Other

6. Release note

Please refer to Release Notes Language Style Guide to write a quality release note. -

provided link for release-policy not working

bugfix

the initial command only works for the BSD variant of sed (MacOS..)  
A syntax error is raised for the GNU variant  
need to remove the extra backup `''` after `-i`   

on OpenSuse tumbleweed:  
Using the initial command gives   

``` shell
 $ sed -i '' 's/karpor-server.karpor.svc/127.0.0.1/g' $HOME/.kube/karpor-hub-cluster.kubeconfig
sed: can't read s/karpor-server.karpor.svc/127.0.0.1/g: No such file or directory

```

and after the fix, it works
Copy link

vercel bot commented Dec 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
kusionstack ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 18, 2024 2:05am

@elliotxx
Copy link
Contributor

@rajp152k Yes, you are right. There are differences in the sed command between Mac and Linux. Thank you for your correction!

Copy link
Contributor

@elliotxx elliotxx left a comment

Choose a reason for hiding this comment

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

lgtm

@elliotxx elliotxx merged commit 2e7b123 into KusionStack:main Dec 18, 2024
6 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Dec 18, 2024
@rajp152k rajp152k deleted the patch-2 branch December 18, 2024 10:30
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.

2 participants