heckyel/git-snapsign
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[README.md]: update syntax

Browse Source
This commit is contained in:
Jesús 2021-04-12 12:49:45 -05:00
parent 316ec13831
commit 76f2ed5254
No known key found for this signature in database
GPG Key ID: F6EE7BC59A315766
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -4,7 +4,9 @@ A small git-integrated script to sign a repository archive tarball for use with
## Usage ## Usage
git-snapsign [--dry-run] [--force] [-s <key-id>] [-F <fmt>] [-p <pfx>] -t <tag> ```console
$ git-snapsign [--dry-run] [--force] [-s <key-id>] [-F <fmt>] [-p <pfx>] -t <tag>
```
`git-snapsign` will create a detached signature for archive output from `git-snapsign` will create a detached signature for archive output from
`git-archive(1)` for `<tag>` and add it to the tag's notes in the `git-archive(1)` for `<tag>` and add it to the tag's notes in the
@ -49,18 +51,26 @@ the snapshots it offers on the repository's summary page.
Create a signature for the archive tarball at tag v1.0.0. Create a signature for the archive tarball at tag v1.0.0.
git-snapsign -t v1.0.0 ```console
$ git-snapsign -t v1.0.0
```
Same as above but use the zip format. Same as above but use the zip format.
git-snapsign -F zip -t v1.0.0 ```console
$ git-snapsign -F zip -t v1.0.0
```
Create a signature with the key corresponding to heckyel@hyperbola.info Create a signature with the key corresponding to heckyel@hyperbola.info
git-snapsign -s 4DF21B6A7C1021B25C360914F6EE7BC59A315766 -t v1.0.0 ```console
$ git-snapsign -s 4DF21B6A7C1021B25C360914F6EE7BC59A315766 -t v1.0.0
```
Use "linux-libre-lts" to create the archive prefix. Useful for when the repository Use "linux-libre-lts" to create the archive prefix. Useful for when the repository
basename is not the canonical name of the project. For example, the basename is not the canonical name of the project. For example, the
linux-libre-lts project may wish to set the prefix this way. linux-libre-lts project may wish to set the prefix this way.
git-snapsign -p linux-libre-lts -t v5.4.96 ```console
$ git-snapsign -p linux-libre-lts -t v5.4.96
```