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

add guide on how to install libgit2 #13743

Merged
merged 7 commits into from Mar 29, 2022
Merged

add guide on how to install libgit2 #13743

merged 7 commits into from Mar 29, 2022

Conversation

grego952
Copy link
Contributor

Description

Changes proposed in this pull request:

  • add troubleshooting guide on how to build and install libgit2 binary

Related issue(s)
Resolves #13732

@kyma-bot kyma-bot added area/serverless Issues or PRs related to serverless size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 25, 2022
@grego952 grego952 added the area/documentation Issues or PRs related to documentation label Mar 25, 2022
kwiatekus
kwiatekus previously approved these changes Mar 25, 2022

## Troubleshooting

### How to build and install `libgit2` binary, required by the Function Controller, on macOS
Copy link
Contributor

Choose a reason for hiding this comment

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

Please follow the troubleshooting template.


```bash
$ cat go.mod | grep git2go
github.com/libgit2/git2go/v31 v31.4.14
Copy link
Contributor

Choose a reason for hiding this comment

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

Is the indentation intentional?

$ cat go.mod | grep git2go
github.com/libgit2/git2go/v31 v31.4.14
```
2. Go to the git2go page to check which version of `libgit2` you must use (e.g. for `libigit2` in version 1.1 the `git2go` version is v31).
Copy link
Contributor

Choose a reason for hiding this comment

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

A link to the page would be very useful here.

components/function-controller/README.md Outdated Show resolved Hide resolved
components/function-controller/README.md Outdated Show resolved Hide resolved
components/function-controller/README.md Outdated Show resolved Hide resolved
Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>
@netlify
Copy link

netlify bot commented Mar 29, 2022

🥰 Documentation preview ready! 🥰

Name Link
🔨 Latest commit 492d9ec
🔍 Latest deploy log https://app.netlify.com/sites/kyma-project-docs-preview/deploys/6242f68f092ec60008e7b75b
😎 Deploy Preview https://deploy-preview-13743--kyma-project-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@kyma-bot kyma-bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 29, 2022
components/function-controller/README.md Outdated Show resolved Hide resolved
components/function-controller/README.md Show resolved Hide resolved
components/function-controller/README.md Outdated Show resolved Hide resolved
components/function-controller/README.md Show resolved Hide resolved

### Cause

Function Controller tests failing.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please explain why the tests are failing. The failing tests are the symptom, not the cause of the problem.

components/function-controller/README.md Outdated Show resolved Hide resolved
components/function-controller/README.md Outdated Show resolved Hide resolved
components/function-controller/README.md Outdated Show resolved Hide resolved
grego952 and others added 2 commits March 29, 2022 12:30
Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>
components/function-controller/README.md Outdated Show resolved Hide resolved
components/function-controller/README.md Outdated Show resolved Hide resolved
Co-authored-by: Klaudia Grzondziel <35192450+klaudiagrz@users.noreply.github.com>
@kyma-bot kyma-bot added the lgtm Looks good to me! label Mar 29, 2022
@kyma-bot kyma-bot merged commit 340208f into kyma-project:main Mar 29, 2022
@grego952 grego952 deleted the libgit2-install-guides branch August 23, 2022 08:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation area/serverless Issues or PRs related to serverless lgtm Looks good to me! size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update function-controller documentation with how to build/install libgit2 on macOS
4 participants