Skip to content

howto setup ssh aliases #440

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.

Sign up for GitHub

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

Open
pbaudin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

howto setup ssh aliases #440

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,17 @@ Running that line once will configure git to always push over https - either for

In more detail: `dune-release publish` always pushes to github over ssh by explicitly giving git the github uri of your project with ssh prefix (`git@github.com:`). By configuring git as suggested above, git will automatically replace that prefix by the https one when pushing and push over https instead.

Even if you set up ssh, the connection may fail when you cloned your project using a ssh alias (to mannage the ssh key to be used).
The uri prefix to your github repository can be extracted from the result of the next command:
```
git config --get remote.origin.url
```

In such a case, we suggest that you configure git as follows (where `my-ssh-alias-to-github` is the uri prefix to your github repository) :
```
git config [--global] url."git@my-ssh-alias-to-github:".pushInsteadOf "git@github.com:"
```

### Create an opam package and submit it to the opam repository

To add the package to OCaml's [opam repository](https://github.com/ocaml/opam-repository), we start by creating an opam file to be used on the opam repository. This file includes the download URI for the distribution tarball and the tarball hash:
Expand Down