aboutsummaryrefslogtreecommitdiffstats
path: root/git.sr.ht
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2020-02-14 16:51:56 -0500
committerDrew DeVault <sir@cmpwn.com>2020-02-14 16:51:56 -0500
commit4098f3ece1b33681b9a6756dda1749f56e4afc26 (patch)
tree0f6fe9cdfc2ae69c61e38dcbb4582998fecc28c0 /git.sr.ht
parent1baa478898e7d6683fab5057b4d809e49da9aecc (diff)
downloadsr.ht-docs-4098f3ece1b33681b9a6756dda1749f56e4afc26.tar.gz
Add docs for attaching binaries to tags
Diffstat (limited to 'git.sr.ht')
-rw-r--r--git.sr.ht/index.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/git.sr.ht/index.md b/git.sr.ht/index.md
index 3ae1f27..45ed39b 100644
--- a/git.sr.ht/index.md
+++ b/git.sr.ht/index.md
@@ -51,6 +51,30 @@ 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