aboutsummaryrefslogtreecommitdiffstats
path: root/git.sr.ht/index.md
blob: 45ed39b784db948de0599424f1238f41064a2a97 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
---
title: git.sr.ht docs
---

[git.sr.ht](https://git.sr.ht) is a service for hosting git repositories on
sr.ht.

**See also**:

- [API reference](api.md)
- [Installation guide](installation.md)

# New to git?

Learning how to use git in general is out of the scope of our documentation.
Here are some good resources:

- [The official Git book](https://git-scm.com/book/en/v2)
- [Git man pages](https://git-scm.com/docs)

We do have some general resources for learning how to use git the sr.ht way:

- [Using git-send-email for sending and reviewing patches on sr.ht](../git.sr.ht/send-email.md)
- [Code review with lists.sr.ht](../lists.sr.ht/code-review.md)

# SSH host keys

```
git.sr.ht ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDZ+l/lvYmaeOAPeijHL8d4794Am0MOvmXPyvHTtrqvgmvCJB8pen/qkQX2S1fgl9VkMGSNxbp7NF7HmKgs5ajTGV9mB5A5zq+161lcp5+f1qmn3Dp1MWKp/AzejWXKW+dwPBd3kkudDBA1fa3uK6g1gK5nLw3qcuv/V4emX9zv3P2ZNlq9XRvBxGY2KzaCyCXVkL48RVTTJJnYbVdRuq8/jQkDRA8lHvGvKI+jqnljmZi2aIrK9OGT2gkCtfyTw2GvNDV6aZ0bEza7nDLU/I+xmByAOO79R1Uk4EYCvSc1WXDZqhiuO2sZRmVxa0pQSBDn1DB3rpvqPYW+UvKB3SOz
git.sr.ht ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBCj6y+cJlqK3BHZRLZuM+KP2zGPrh4H66DacfliU1E2DHAd1GGwF4g1jwu3L8gOZUTIvUptqWTkmglpYhFp4Iy4=
git.sr.ht ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIMZvRd4EtM7R+IHVMWmDkVU3VLQTSwQDSAvW0t2Tkj60
```

# git.sr.ht manual

The following sections document various features of git.sr.ht.

## Repository creation

Creating new repositories is done on the [create
page](https://git.sr.ht/create), which you can access from any page via the
navigation on the top right. You can also create a new repository by pushing to
one that does not yet exist, and clicking the link which is printed in the `git
push` output to complete the creation process.

The *name* and *description* fields are used to describe your repository to the
public. The *visibility* field will change how your repository is shown on the
website. Public repositories are visible on your profile, to anonymous users,
and on third-party search engines. Unlisted repositories are visible to anyone
who has the link, but are not shown in your profile or in search results.
Private repositories are only visible to you and other logged-in users who you
explicitly [grant access to](#access).

## Attaching files to releases

git.sr.ht allows you to attach files, such as executables (aka binaries), PGP
signatures, and so on, to *annotated tags*. To create an annotated tag, run the
following git command:

```
git tag -a <tag name>
```

For example, `git tag -a 2.3.4` to tag version 2.3.4. Your text editor will
open, and you'll be prompted to *annotate* the tag - fill this in with release
notes, a changelog, etc. Consider using
[`git-shortlog`](https://git-scm.com/docs/git-shortlog) to generate your
changelog.

Save and close your editor, then use `git push --tags` to publish the new tag
(or, use `git push --follow-tags` to push any local commits to the current
branch, along with the new tag. This can be made the default by running `git
config --global push.followTags true`).

The new tag will appear on the "refs" page of your repository. To attach files
to it, click the tag name (e.g. "2.3.4") and use the upload form on this page.

## Source code annotations

You can generate annotations for your source code to display on git.sr.ht. For
more information [see this document](annotations.md).

## Settings

Each repository's settings may be accessed via the settings link on the
repository's detail page.

### Info

You can change the repository's visibility and description on this page. Click
"Rename?" if you wish to rename your repository. Renaming your repository sets
up a redirect from the previous name to the new.

### Access

The access page allows you to grant other users read or write access to your
repository. Users with read access will be able to clone and view private
repositories on the web, and users with write access will be able to push new
to your repository. Users with write access will not be able to edit your
repository's settings.

### Delete

You can delete your repository from this page. This operation cannot be undone.
This does not delete any other resources that may be associated with this
project, such as a ticket tracker on todo.sr.ht or build history on
builds.sr.ht.

## Profile

Your public profile is available at git.sr.ht/~username. Here any public
repositories on your account are listed and searchable, but unlisted and private
repositories are hidden unless you're logged in.

The information displayed on your profile page is sourced from your [meta.sr.ht
profile](/meta.sr.ht#profile).