Changes how docs are built

pull/662/head
sobolevn 3 years ago committed by Nikita Sobolev
parent ce73d9d43c
commit ca500fa13f

@ -9,7 +9,7 @@ Here's how it's done:
4. You can also spell check your code using 'aspell -c {filename}' 4. You can also spell check your code using 'aspell -c {filename}'
5. If you are adding or changing features, please add tests that cover the new behavior (in addition to the unchanged behavior if appropriate) 5. If you are adding or changing features, please add tests that cover the new behavior (in addition to the unchanged behavior if appropriate)
6. Make sure that all tests pass 6. Make sure that all tests pass
7. Change the .ronn file(s) in man/man*/ to document your changes if appropriate 7. Change the .md file(s) in man/man*/ to document your changes if appropriate
(regenerating man pages with 'make build-man' is optional) (regenerating man pages with 'make build-man' is optional)
8. Add an entry to CHANGELOG.md explaining the change briefly and, if appropriate, referring to the related issue # 8. Add an entry to CHANGELOG.md explaining the change briefly and, if appropriate, referring to the related issue #

@ -12,10 +12,8 @@ jobs:
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: Build manuals - name: Build docs
run: | run: make docs
make build-man
cp -r man/ docs/man
- name: Deploy to Pages - name: Deploy to Pages
uses: JamesIves/github-pages-deploy-action@4.1.1 uses: JamesIves/github-pages-deploy-action@4.1.1

@ -90,7 +90,7 @@ This will copy the hooks from utils/hooks into .git/hooks/pre-commit and .git/ho
5. Add an entry to CHANGELOG.md, referring to the related issue # if appropriate 5. Add an entry to CHANGELOG.md, referring to the related issue # if appropriate
6. Change the .ronn file(s) in man/man1 and man/man7 to document your changes if appropriate 6. Change the `man` source file(s) (we write them in markdown) in `man/man1` and `man/man7` to document your changes if appropriate
7. Now, add all your files to the commit with `git add --all` and commit changes with `git commit`. 7. Now, add all your files to the commit with `git add --all` and commit changes with `git commit`.
Write a good commit message which explains your work Write a good commit message which explains your work
@ -130,32 +130,15 @@ output from commands.
To create a new release, (you'll first need permission to commit to the repo, of course): To create a new release, (you'll first need permission to commit to the repo, of course):
Update the content of `CHANGELOG.md` for the release (this should be a matter of changing headers), Update the content of `CHANGELOG.md` for the release (this should be a matter of changing headers),
and update the version string in `src/version.sh`. Then, when you `commit` these changes, and update the version string in `src/version.sh`.
the git-hooks described below will perform most of the steps needed for the github release.
So a lot of the release process is defined in the `git`-hooks and `.travis.yml`. When creating a commit inside the `master` branch (it is usually a documentation and changelog update with the version bump inside `src/version.sh`).
When creating a commit inside the `master` branch (it is usually a documentation and changelog update with the version bump inside `src/version.sh`) the Then, push your code to GitHub. It will start the CI.
pre-commit and post-commit hooks will trigger three events.
- `pre-commit`: run the test suite will be locally After all the checks have executed, GitHub Actions will test and build releases for specific platforms.
- `pre-commit`: generate and update the manuals and add them to the current commit with `make build-man` While CI is doing it's building and testing, finish the release on github by pushing the new tag with:
- `post-commit`: a GitHub Action will update the `gh-pages` branch to match the `docs` folder in the `master` branch, which will push updated manuals to the [git-secret site][git-secret-site].
- `post-commit`: new `git` tag (such as v0.3.1) will be automatically created if the version is changed, using something like
```bash
if [[ "$NEWEST_TAG" != "v${SCRIPT_VERSION}" ]]; then
git tag -a "v${SCRIPT_VERSION}" -m "version $SCRIPT_VERSION"
fi
```
After all the above hooks have executed, travis-ci will test and build releases for specific platforms
(see https://bintray.com/sobolevn/deb/git-secret, https://bintray.com/sobolevn/rpm/git-secret, etc).
While travis is doing it's building and testing, finish the release on github by pushing the new tag with:
```bash ```bash
git push --tags git push --tags

@ -22,13 +22,11 @@ build: git-secret
.PHONY: install .PHONY: install
install: install:
chmod +x "./utils/install.sh"; sync; \ ${SHELL} ./utils/install.sh "${DESTDIR}${PREFIX}"
"./utils/install.sh" "${DESTDIR}${PREFIX}"
.PHONY: uninstall .PHONY: uninstall
uninstall: uninstall:
chmod +x "./utils/uninstall.sh"; sync; \ ${SHELL} ./utils/uninstall.sh "${DESTDIR}${PREFIX}"
"./utils/uninstall.sh" "${DESTDIR}${PREFIX}"
# #
# Testing and linting: # Testing and linting:
@ -39,10 +37,9 @@ uninstall:
# Using a sub-shell we get the raw *nix paths, e.g. /c/Something # Using a sub-shell we get the raw *nix paths, e.g. /c/Something
.PHONY: test .PHONY: test
test: clean build test: clean build
chmod +x "./utils/tests.sh"; sync; \
export SECRET_PROJECT_ROOT="$(shell echo $${PWD})"; \ export SECRET_PROJECT_ROOT="$(shell echo $${PWD})"; \
export PATH="$(shell echo $${PWD})/vendor/bats-core/bin:$(shell echo $${PWD}):$(shell echo $${PATH})"; \ export PATH="$(shell echo $${PWD})/vendor/bats-core/bin:$(shell echo $${PWD}):$(shell echo $${PATH})"; \
"./utils/tests.sh" ${SHELL} ./utils/tests.sh
# We use this script in CI and you can do this too! # We use this script in CI and you can do this too!
# What happens here? # What happens here?
@ -69,7 +66,7 @@ lint-shell:
-w /code \ -w /code \
-e SHELLCHECK_OPTS='-s bash -S warning -a' \ -e SHELLCHECK_OPTS='-s bash -S warning -a' \
--rm koalaman/shellcheck \ --rm koalaman/shellcheck \
$$(find src .ci utils tests -type f \ $$(find src .ci utils tests docs -type f \
-name '*.sh' -o -name '*.bash' -o -name '*.bats') -name '*.sh' -o -name '*.bash' -o -name '*.bats')
.PHONY: lint-docker .PHONY: lint-docker
@ -87,30 +84,44 @@ lint-docker:
lint: lint-shell lint-docker lint: lint-shell lint-docker
# #
# Manuals: # Manuals and docs:
# #
.PHONY: clean-man .PHONY: clean-man
clean-man: clean-man:
find "man/" -type f -name "*.roff" -delete find "man/" -type f ! -name "*.md" -delete
.PHONY: build-man .PHONY: build-man
build-man: clean-man git-secret build-man: git-secret
# Prepare: # Prepare:
touch man/*/*.ronn touch man/*/*.md
# Build docker image: # Build docker image:
docker pull msoap/ruby-ronn docker pull msoap/ruby-ronn
# Do the manual generation: # Do the manual generation:
GITSECRET_VERSION=`./git-secret --version` docker run \ export GITSECRET_VERSION="$$(./git-secret --version)" && docker run \
--volume="$${PWD}:/code" \ --volume="$${PWD}:/code" \
-w /code \ -w /code \
--rm msoap/ruby-ronn \ --rm msoap/ruby-ronn \
ronn --roff \ ronn --roff \
--organization=sobolevn \ --organization=sobolevn \
--manual="git-secret $${GITSECRET_VERSION}" \ --manual="git-secret $${GITSECRET_VERSION}" \
man/*/*.ronn man/*/*.md
.PHONY: build-docs
build-docs: build-man
${SHELL} docs/create_posts.sh
.PHONY: docs
docs: build-docs
docker pull jekyll/jekyll
docker run \
--volume="$${PWD}/docs:/code" \
-w /code \
-p 4000:4000 \
--rm jekyll/jekyll \
jekyll serve --safe --strict_front_matter
# #
# Packaging: # Packaging:

@ -0,0 +1,6 @@
source "https://rubygems.org"
group :jekyll_plugins do
gem "jekyll", ">= 3.6.3"
gem "jekyll-seo-tag", "~> 2.7.1"
end

@ -0,0 +1,70 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.7.0)
public_suffix (>= 2.0.2, < 5.0)
colorator (1.1.0)
concurrent-ruby (1.1.7)
em-websocket (0.5.2)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.7)
ffi (1.14.2)
forwardable-extended (2.6.0)
http_parser.rb (0.6.0)
i18n (1.8.5)
concurrent-ruby (~> 1.0)
jekyll (4.2.0)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (~> 2.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (~> 0.4.0)
pathutil (~> 0.9)
rouge (~> 3.0)
safe_yaml (~> 1.0)
terminal-table (~> 2.0)
jekyll-sass-converter (2.1.0)
sassc (> 2.0.1, < 3.0)
jekyll-seo-tag (2.7.1)
jekyll (>= 3.8, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.3.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.3.3)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.6)
rb-fsevent (0.10.4)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.3)
rouge (3.26.0)
safe_yaml (1.0.5)
sassc (2.4.0)
ffi (~> 1.9)
terminal-table (2.0.0)
unicode-display_width (~> 1.1, >= 1.1.1)
unicode-display_width (1.7.0)
PLATFORMS
x86_64-linux-musl
DEPENDENCIES
jekyll (>= 3.6.3)
jekyll-seo-tag (~> 2.7.1)
BUNDLED WITH
2.2.2

@ -11,7 +11,7 @@ email: mail@sobolevn.me
description: > # this means to ignore newlines until "baseurl:" description: > # this means to ignore newlines until "baseurl:"
A bash-tool to store your private data inside a git repository. A bash-tool to store your private data inside a git repository.
baseurl: "" # the subpath of your site, e.g. /blog baseurl: "" # the subpath of your site, e.g. /blog
url: "http://sobolevn.github.io" # the base hostname & protocol for your site url: "git-secret.io" # the base hostname & protocol for your site
# Github links: # Github links:
github_username: sobolevn github_username: sobolevn

@ -15,11 +15,9 @@
<div class="trigger"> <div class="trigger">
<!-- Place this tag where you want the button to render. --> <!-- Place this tag where you want the button to render. -->
<a class="github-button" <a class="github-button" href="https://github.com/sobolevn/git-secret" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star git-secret on GitHub">
href="https://github.com/sobolevn/git-secret#git-secret" Star
data-style="mega" aria-label="Download sobolevn/git-secret on GitHub"> </a>
Download
</a>
</div> </div>
</div> </div>
@ -33,3 +31,6 @@
</nav> </nav>
</header> </header>
<!-- Required for GitHub buttons. -->
<script async defer src="https://buttons.github.io/buttons.js"></script>

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret-add' title: 'git-secret-add'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret-add permalink: git-secret-add
categories: command categories: command
--- ---
@ -10,7 +10,7 @@ git-secret-add - starts to track added files.
## SYNOPSIS ## SYNOPSIS
git secret add [-i] <pathspec>... git secret add [-v] [-i] <pathspec>...
## DESCRIPTION ## DESCRIPTION
@ -30,6 +30,7 @@ folder using the SECRETS_DIR environment variable.
## OPTIONS ## OPTIONS
-v - verbose, shows extra information.
-i - does nothing, adding paths to .gitignore is now the default behavior. -i - does nothing, adding paths to .gitignore is now the default behavior.
-h - shows this help. -h - shows this help.

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret-cat' title: 'git-secret-cat'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret-cat permalink: git-secret-cat
categories: command categories: command
--- ---

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret-changes' title: 'git-secret-changes'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret-changes permalink: git-secret-changes
categories: command categories: command
--- ---

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret-clean' title: 'git-secret-clean'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret-clean permalink: git-secret-clean
categories: command categories: command
--- ---

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret-hide' title: 'git-secret-hide'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret-hide permalink: git-secret-hide
categories: command categories: command
--- ---

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret-init' title: 'git-secret-init'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret-init permalink: git-secret-init
categories: command categories: command
--- ---

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret-killperson' title: 'git-secret-killperson'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret-killperson permalink: git-secret-killperson
categories: command categories: command
--- ---

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret-list' title: 'git-secret-list'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret-list permalink: git-secret-list
categories: command categories: command
--- ---

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret-remove' title: 'git-secret-remove'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret-remove permalink: git-secret-remove
categories: command categories: command
--- ---

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret-reveal' title: 'git-secret-reveal'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret-reveal permalink: git-secret-reveal
categories: command categories: command
--- ---

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret-tell' title: 'git-secret-tell'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret-tell permalink: git-secret-tell
categories: command categories: command
--- ---
@ -14,12 +14,16 @@ git-secret-tell - adds a person, who can access private data.
## DESCRIPTION ## DESCRIPTION
`git-secret-tell` receives one or more email addresses as an input, searches for the `gpg`-key in the `gpg` `git-secret tell` receives one or more email addresses as an input, searches for the `gpg`-key in the `gpg`
`homedir` by these emails, then imports the corresponding public key into `git-secret`'s inner keychain. `homedir` by these emails, then imports the corresponding public key into `git-secret`'s inner keychain.
From this moment this person can encrypt new files with the keyring which contains their key, From this moment this person can encrypt new files with the keyring which contains their key,
but they cannot decrypt the old files, which were already encrypted without their key. but they cannot decrypt the old files, which were already encrypted without their key.
The files should be re-encrypted with the new keyring by someone who has the unencrypted files. The files should be re-encrypted with the new keyring by someone who has the unencrypted files.
Because `git-secret tell` works with only email addresses, it will exit with an error if you have
multiple keys in your keychain with specified email addresses, or if one of the specified emails
is already associated with a key in the git-secret keychain.
Versions of `git-secret tell` after 0.3.2 will warn about keys that are expired, revoked, or otherwise invalid, Versions of `git-secret tell` after 0.3.2 will warn about keys that are expired, revoked, or otherwise invalid,
and also if multiple keys are found for a single email address. and also if multiple keys are found for a single email address.

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret-usage' title: 'git-secret-usage'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret-usage permalink: git-secret-usage
categories: command categories: command
--- ---

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret-whoknows' title: 'git-secret-whoknows'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret-whoknows permalink: git-secret-whoknows
categories: command categories: command
--- ---

@ -1,7 +1,7 @@
--- ---
layout: post layout: post
title: 'git-secret' title: 'git-secret'
date: 2020-09-20 15:12:56 -0400 date: 2021-05-04 12:15:29 +0300
permalink: git-secret permalink: git-secret
categories: usage categories: usage
--- ---
@ -48,7 +48,7 @@ And you're done!
4. The newly added user cannot yet read the encrypted files. Now, re-encrypt the files using 4. The newly added user cannot yet read the encrypted files. Now, re-encrypt the files using
`git secret reveal; git secret hide -d`, and then commit and push the newly encrypted files. `git secret reveal; git secret hide -d`, and then commit and push the newly encrypted files.
(The `-d` options deletes the unencrypted file after re-encrypting it). (The -d options deletes the unencrypted file after re-encrypting it).
Now the newly added user will be able to decrypt the files in the repo using `git-secret reveal`. Now the newly added user will be able to decrypt the files in the repo using `git-secret reveal`.
Note that it is possible to add yourself to the git-secret repo without decrypting existing files. Note that it is possible to add yourself to the git-secret repo without decrypting existing files.
@ -140,22 +140,22 @@ After doing so rerun the tests to be sure that it won't break anything. Tested t
It can be changed to any valid directory name. It can be changed to any valid directory name.
* `$SECRETS_PINENTRY` - allows user to specify a setting for `gpg`'s --pinentry option. * `$SECRETS_PINENTRY` - allows user to specify a setting for `gpg`'s --pinentry option.
See `gpg` docs for details about `gpg`'s `--pinentry` option. See `gpg` docs for details about gpg's --pinentry option.
## The `.gitsecret` folder (can be overridden with SECRETS_DIR) ## The `.gitsecret` folder (can be overridden with SECRETS_DIR)
This folder contains information about the files encrypted by git-secret, This folder contains information about the files encrypted by git-secret,
and about which public/private key sets can access the encrypted data. and about which public/private key sets can access the encrypted data.
You can change the name of this directory using the `SECRETS_DIR` environment variable. You can change the name of this directory using the SECRETS_DIR environment variable.
Use the various `git-secret` commands to manipulate the files in `.gitsecret`, Use the various 'git secret' commands to manipulate the files in `.gitsecret`,
you should not change the data in these files directly. you should not change the data in these files directly.
Exactly which files exist in the `.gitsecret` folder and what their contents are Exactly which files exist in the `.gitsecret` folder and what their contents are
vary slightly across different versions of gpg. Thus it is best to use vary slightly across different versions of gpg. Thus it is best to use
git-secret with the same version of gpg being used by all users. git-secret with the same version of gpg being used by all users.
This can be forced using `SECRETS_GPG_COMMAND` environment variable. This can be forced using SECRETS_GPG_COMMAND environment variable.
Specifically, there is an issue between gpg version 2.1.20 and later versions Specifically, there is an issue between gpg version 2.1.20 and later versions
which can cause problems reading and writing keyring files between systems which can cause problems reading and writing keyring files between systems
@ -177,4 +177,4 @@ This directory contains data used by git-secret and PGP to allow and maintain th
Generally speaking, all the files in this directory *except* `random_seed` should be checked into your repo. Generally speaking, all the files in this directory *except* `random_seed` should be checked into your repo.
By default, `git secret init` will add the file `.gitsecret/keys/random_seed` to your `.gitignore` file. By default, `git secret init` will add the file `.gitsecret/keys/random_seed` to your `.gitignore` file.
Again, you can change the name of this directory using the `SECRETS_DIR` environment variable. Again, you can change the name of this directory using the SECRETS_DIR environment variable.

@ -0,0 +1,62 @@
#!/usr/bin/env bash
# Should be called from the root folder, not inside `docs/` folder
# See `make build-docs`
set -e
MAN_LOCATION='man/man1'
MAN7_LOCATION='man/man7'
POSTS_LOCATION='docs/_posts'
function checkout_manuals {
cp -r man/ docs/man
}
function copy_to_posts {
# Cleaning old files:
rm -f "$POSTS_LOCATION/*.md"
rm -rf "$POSTS_LOCATION"
mkdir -p "$POSTS_LOCATION"
# Moving new command files:
local timestamp
local current_date
timestamp=$(date "+%Y-%m-%d %H:%M:%S %z")
current_date=$(date "+%Y-%m-%d")
# Creating command refernce:
for com in $MAN_LOCATION/git-secret-*.1.md; do
local short_name
short_name=$(echo "$com" | sed -n "s|$MAN_LOCATION/\(.*\)\.1\.md|\1|p")
local command_header="---
layout: post
title: '${short_name}'
date: ${timestamp}
permalink: ${short_name}
categories: command
---"
local post_filename="$POSTS_LOCATION/${current_date}-${short_name}.md"
echo "$command_header" > "$post_filename"
cat "$com" >> "$post_filename"
done
# Creating main usage file:
local usage_header="---
layout: post
title: 'git-secret'
date: ${timestamp}
permalink: git-secret
categories: usage
---"
local usage_filename="$POSTS_LOCATION/${current_date}-git-secret.md"
echo "$usage_header" > "$usage_filename"
cat "$MAN7_LOCATION/git-secret.7.md" >> "$usage_filename"
}
checkout_manuals
copy_to_posts

@ -35,7 +35,7 @@ There are several ways to install `git-secret`:
### `deb` package ### `deb` package
You can find the `deb` repository [here](https://bintray.com/sobolevn/deb/git-secret). You can find the `deb` repository [here](https://bintray.com/sobolevn/deb/git-secret).
Pre-requirements: make sure you have installed `apt-transport-https` Pre-requirements: make sure you have installed `apt-transport-https` and `ca-certificates`
```bash ```bash
echo "deb https://dl.bintray.com/sobolevn/deb git-secret main" | sudo tee -a /etc/apt/sources.list echo "deb https://dl.bintray.com/sobolevn/deb git-secret main" | sudo tee -a /etc/apt/sources.list

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET\-ADD" "1" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET\-ADD" "1" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\-add\fR \- starts to track added files\. \fBgit\-secret\-add\fR \- starts to track added files\.

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET\-CAT" "1" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET\-CAT" "1" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\-cat\fR \- decrypts files passed on command line to stdout \fBgit\-secret\-cat\fR \- decrypts files passed on command line to stdout

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET\-CHANGES" "1" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET\-CHANGES" "1" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\-changes\fR \- view diff of the hidden files\. \fBgit\-secret\-changes\fR \- view diff of the hidden files\.

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET\-CLEAN" "1" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET\-CLEAN" "1" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\-clean\fR \- removes all the hidden files\. \fBgit\-secret\-clean\fR \- removes all the hidden files\.

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET\-HIDE" "1" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET\-HIDE" "1" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\-hide\fR \- encrypts all added files with the inner keyring\. \fBgit\-secret\-hide\fR \- encrypts all added files with the inner keyring\.

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET\-INIT" "1" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET\-INIT" "1" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\-init\fR \- initializes git\-secret repository\. \fBgit\-secret\-init\fR \- initializes git\-secret repository\.

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET\-KILLPERSON" "1" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET\-KILLPERSON" "1" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\-killperson\fR \- deletes key identified by an email from the inner keyring\. \fBgit\-secret\-killperson\fR \- deletes key identified by an email from the inner keyring\.

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET\-LIST" "1" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET\-LIST" "1" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\-list\fR \- prints all the added files\. \fBgit\-secret\-list\fR \- prints all the added files\.

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET\-REMOVE" "1" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET\-REMOVE" "1" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\-remove\fR \- removes files from index\. \fBgit\-secret\-remove\fR \- removes files from index\.

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET\-REVEAL" "1" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET\-REVEAL" "1" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\-reveal\fR \- decrypts all added files\. \fBgit\-secret\-reveal\fR \- decrypts all added files\.

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET\-TELL" "1" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET\-TELL" "1" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\-tell\fR \- adds a person, who can access private data\. \fBgit\-secret\-tell\fR \- adds a person, who can access private data\.

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET\-USAGE" "1" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET\-USAGE" "1" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\-usage\fR \- prints all the available commands\. \fBgit\-secret\-usage\fR \- prints all the available commands\.

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET\-WHOKNOWS" "1" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET\-WHOKNOWS" "1" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\-whoknows\fR \- prints email\-labels for each key in the keyring\. \fBgit\-secret\-whoknows\fR \- prints email\-labels for each key in the keyring\.

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "GIT\-SECRET" "7" "May 2021" "sobolevn" "git-secret " .TH "GIT\-SECRET" "7" "May 2021" "sobolevn" "git-secret 0.4.0.alpha1"
. .
.SH "NAME" .SH "NAME"
\fBgit\-secret\fR \- bash tool to store private data inside a git repo\. \fBgit\-secret\fR \- bash tool to store private data inside a git repo\.

@ -51,7 +51,7 @@ function preinstall_files {
install -m "$EXEC_PEM" -d "${SCRIPT_DEST_DIR}/usr/share/man/man1" install -m "$EXEC_PEM" -d "${SCRIPT_DEST_DIR}/usr/share/man/man1"
install -m "$EXEC_PEM" -d "${SCRIPT_DEST_DIR}/usr/share/man/man7" install -m "$EXEC_PEM" -d "${SCRIPT_DEST_DIR}/usr/share/man/man7"
for file in man/man1/* ; do for file in man/man1/* ; do
if [[ "$file" == *.ronn ]]; then if [[ "$file" == *.md ]]; then
continue continue
fi fi

Loading…
Cancel
Save