diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index bcd72798..d5c7602b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,7 +9,7 @@ Here's how it's done: 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) 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) 8. Add an entry to CHANGELOG.md explaining the change briefly and, if appropriate, referring to the related issue # diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml index 4519d8a8..f617de19 100644 --- a/.github/workflows/github-pages.yml +++ b/.github/workflows/github-pages.yml @@ -12,10 +12,8 @@ jobs: steps: - uses: actions/checkout@v2 - - name: Build manuals - run: | - make build-man - cp -r man/ docs/man + - name: Build docs + run: make docs - name: Deploy to Pages uses: JamesIves/github-pages-deploy-action@4.1.1 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2acb5997..852e1df8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 -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`. 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): 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, -the git-hooks described below will perform most of the steps needed for the github release. +and update the version string in `src/version.sh`. -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 -pre-commit and post-commit hooks will trigger three events. +Then, push your code to GitHub. It will start the CI. -- `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` - -- `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: +While CI is doing it's building and testing, finish the release on github by pushing the new tag with: ```bash git push --tags diff --git a/Makefile b/Makefile index 8a5db3e0..f70bea36 100644 --- a/Makefile +++ b/Makefile @@ -22,13 +22,11 @@ build: git-secret .PHONY: install install: - chmod +x "./utils/install.sh"; sync; \ - "./utils/install.sh" "${DESTDIR}${PREFIX}" + ${SHELL} ./utils/install.sh "${DESTDIR}${PREFIX}" .PHONY: uninstall uninstall: - chmod +x "./utils/uninstall.sh"; sync; \ - "./utils/uninstall.sh" "${DESTDIR}${PREFIX}" + ${SHELL} ./utils/uninstall.sh "${DESTDIR}${PREFIX}" # # Testing and linting: @@ -39,10 +37,9 @@ uninstall: # Using a sub-shell we get the raw *nix paths, e.g. /c/Something .PHONY: test test: clean build - chmod +x "./utils/tests.sh"; sync; \ export SECRET_PROJECT_ROOT="$(shell echo $${PWD})"; \ 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! # What happens here? @@ -69,7 +66,7 @@ lint-shell: -w /code \ -e SHELLCHECK_OPTS='-s bash -S warning -a' \ --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') .PHONY: lint-docker @@ -87,30 +84,44 @@ lint-docker: lint: lint-shell lint-docker # -# Manuals: +# Manuals and docs: # .PHONY: clean-man clean-man: - find "man/" -type f -name "*.roff" -delete + find "man/" -type f ! -name "*.md" -delete .PHONY: build-man -build-man: clean-man git-secret +build-man: git-secret # Prepare: - touch man/*/*.ronn + touch man/*/*.md # Build docker image: docker pull msoap/ruby-ronn # Do the manual generation: - GITSECRET_VERSION=`./git-secret --version` docker run \ + export GITSECRET_VERSION="$$(./git-secret --version)" && docker run \ --volume="$${PWD}:/code" \ -w /code \ --rm msoap/ruby-ronn \ ronn --roff \ --organization=sobolevn \ --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: diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 00000000..4f0b0f6b --- /dev/null +++ b/docs/Gemfile @@ -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 diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 00000000..c9381900 --- /dev/null +++ b/docs/Gemfile.lock @@ -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 diff --git a/docs/_config.yml b/docs/_config.yml index ad1c222a..08e49fc6 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -11,7 +11,7 @@ email: mail@sobolevn.me description: > # this means to ignore newlines until "baseurl:" A bash-tool to store your private data inside a git repository. 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_username: sobolevn diff --git a/docs/_includes/header.html b/docs/_includes/header.html index 378740a5..d43b9f61 100644 --- a/docs/_includes/header.html +++ b/docs/_includes/header.html @@ -15,11 +15,9 @@
- - Download - + + Star +
@@ -33,3 +31,6 @@ + + + diff --git a/docs/_posts/2020-09-20-git-secret-add.md b/docs/_posts/2021-05-04-git-secret-add.md similarity index 92% rename from docs/_posts/2020-09-20-git-secret-add.md rename to docs/_posts/2021-05-04-git-secret-add.md index 2481005b..8cfe22bc 100644 --- a/docs/_posts/2020-09-20-git-secret-add.md +++ b/docs/_posts/2021-05-04-git-secret-add.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret-add' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret-add categories: command --- @@ -10,7 +10,7 @@ git-secret-add - starts to track added files. ## SYNOPSIS - git secret add [-i] ... + git secret add [-v] [-i] ... ## DESCRIPTION @@ -30,6 +30,7 @@ folder using the SECRETS_DIR environment variable. ## OPTIONS + -v - verbose, shows extra information. -i - does nothing, adding paths to .gitignore is now the default behavior. -h - shows this help. diff --git a/docs/_posts/2020-09-20-git-secret-cat.md b/docs/_posts/2021-05-04-git-secret-cat.md similarity index 97% rename from docs/_posts/2020-09-20-git-secret-cat.md rename to docs/_posts/2021-05-04-git-secret-cat.md index cb27e43e..23703836 100644 --- a/docs/_posts/2020-09-20-git-secret-cat.md +++ b/docs/_posts/2021-05-04-git-secret-cat.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret-cat' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret-cat categories: command --- diff --git a/docs/_posts/2020-09-20-git-secret-changes.md b/docs/_posts/2021-05-04-git-secret-changes.md similarity index 97% rename from docs/_posts/2020-09-20-git-secret-changes.md rename to docs/_posts/2021-05-04-git-secret-changes.md index b9a9d3fe..50b5c0cf 100644 --- a/docs/_posts/2020-09-20-git-secret-changes.md +++ b/docs/_posts/2021-05-04-git-secret-changes.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret-changes' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret-changes categories: command --- diff --git a/docs/_posts/2020-09-20-git-secret-clean.md b/docs/_posts/2021-05-04-git-secret-clean.md similarity index 96% rename from docs/_posts/2020-09-20-git-secret-clean.md rename to docs/_posts/2021-05-04-git-secret-clean.md index 773b6ca6..ec6c0880 100644 --- a/docs/_posts/2020-09-20-git-secret-clean.md +++ b/docs/_posts/2021-05-04-git-secret-clean.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret-clean' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret-clean categories: command --- diff --git a/docs/_posts/2020-09-20-git-secret-hide.md b/docs/_posts/2021-05-04-git-secret-hide.md similarity index 98% rename from docs/_posts/2020-09-20-git-secret-hide.md rename to docs/_posts/2021-05-04-git-secret-hide.md index 65213ce6..6ecf4abc 100644 --- a/docs/_posts/2020-09-20-git-secret-hide.md +++ b/docs/_posts/2021-05-04-git-secret-hide.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret-hide' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret-hide categories: command --- diff --git a/docs/_posts/2020-09-20-git-secret-init.md b/docs/_posts/2021-05-04-git-secret-init.md similarity index 97% rename from docs/_posts/2020-09-20-git-secret-init.md rename to docs/_posts/2021-05-04-git-secret-init.md index 242e8555..0aee93d7 100644 --- a/docs/_posts/2020-09-20-git-secret-init.md +++ b/docs/_posts/2021-05-04-git-secret-init.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret-init' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret-init categories: command --- diff --git a/docs/_posts/2020-09-20-git-secret-killperson.md b/docs/_posts/2021-05-04-git-secret-killperson.md similarity index 96% rename from docs/_posts/2020-09-20-git-secret-killperson.md rename to docs/_posts/2021-05-04-git-secret-killperson.md index 635a4355..1c11ed3b 100644 --- a/docs/_posts/2020-09-20-git-secret-killperson.md +++ b/docs/_posts/2021-05-04-git-secret-killperson.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret-killperson' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret-killperson categories: command --- diff --git a/docs/_posts/2020-09-20-git-secret-list.md b/docs/_posts/2021-05-04-git-secret-list.md similarity index 96% rename from docs/_posts/2020-09-20-git-secret-list.md rename to docs/_posts/2021-05-04-git-secret-list.md index f08efe26..882f1881 100644 --- a/docs/_posts/2020-09-20-git-secret-list.md +++ b/docs/_posts/2021-05-04-git-secret-list.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret-list' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret-list categories: command --- diff --git a/docs/_posts/2020-09-20-git-secret-remove.md b/docs/_posts/2021-05-04-git-secret-remove.md similarity index 96% rename from docs/_posts/2020-09-20-git-secret-remove.md rename to docs/_posts/2021-05-04-git-secret-remove.md index 3a49fb36..48e67133 100644 --- a/docs/_posts/2020-09-20-git-secret-remove.md +++ b/docs/_posts/2021-05-04-git-secret-remove.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret-remove' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret-remove categories: command --- diff --git a/docs/_posts/2020-09-20-git-secret-reveal.md b/docs/_posts/2021-05-04-git-secret-reveal.md similarity index 97% rename from docs/_posts/2020-09-20-git-secret-reveal.md rename to docs/_posts/2021-05-04-git-secret-reveal.md index 7fed39f7..bfb50d4c 100644 --- a/docs/_posts/2020-09-20-git-secret-reveal.md +++ b/docs/_posts/2021-05-04-git-secret-reveal.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret-reveal' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret-reveal categories: command --- diff --git a/docs/_posts/2020-09-20-git-secret-tell.md b/docs/_posts/2021-05-04-git-secret-tell.md similarity index 82% rename from docs/_posts/2020-09-20-git-secret-tell.md rename to docs/_posts/2021-05-04-git-secret-tell.md index e2c6eefe..5ed3cd84 100644 --- a/docs/_posts/2020-09-20-git-secret-tell.md +++ b/docs/_posts/2021-05-04-git-secret-tell.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret-tell' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret-tell categories: command --- @@ -14,12 +14,16 @@ git-secret-tell - adds a person, who can access private data. ## 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. 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. 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, and also if multiple keys are found for a single email address. diff --git a/docs/_posts/2020-09-20-git-secret-usage.md b/docs/_posts/2021-05-04-git-secret-usage.md similarity index 95% rename from docs/_posts/2020-09-20-git-secret-usage.md rename to docs/_posts/2021-05-04-git-secret-usage.md index fd29c398..b68833f9 100644 --- a/docs/_posts/2020-09-20-git-secret-usage.md +++ b/docs/_posts/2021-05-04-git-secret-usage.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret-usage' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret-usage categories: command --- diff --git a/docs/_posts/2020-09-20-git-secret-whoknows.md b/docs/_posts/2021-05-04-git-secret-whoknows.md similarity index 96% rename from docs/_posts/2020-09-20-git-secret-whoknows.md rename to docs/_posts/2021-05-04-git-secret-whoknows.md index bbee51aa..2bdd74fa 100644 --- a/docs/_posts/2020-09-20-git-secret-whoknows.md +++ b/docs/_posts/2021-05-04-git-secret-whoknows.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret-whoknows' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret-whoknows categories: command --- diff --git a/docs/_posts/2020-09-20-git-secret.md b/docs/_posts/2021-05-04-git-secret.md similarity index 94% rename from docs/_posts/2020-09-20-git-secret.md rename to docs/_posts/2021-05-04-git-secret.md index ca30f777..b6aabfb5 100644 --- a/docs/_posts/2020-09-20-git-secret.md +++ b/docs/_posts/2021-05-04-git-secret.md @@ -1,7 +1,7 @@ --- layout: post title: 'git-secret' -date: 2020-09-20 15:12:56 -0400 +date: 2021-05-04 12:15:29 +0300 permalink: git-secret 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 `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`. 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. * `$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) This folder contains information about the files encrypted by git-secret, 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. 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 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 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. 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. diff --git a/docs/create_posts.sh b/docs/create_posts.sh new file mode 100644 index 00000000..d0ce5787 --- /dev/null +++ b/docs/create_posts.sh @@ -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 diff --git a/docs/installation.md b/docs/installation.md index 3a562797..0154cf4a 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -35,7 +35,7 @@ There are several ways to install `git-secret`: ### `deb` package 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 echo "deb https://dl.bintray.com/sobolevn/deb git-secret main" | sudo tee -a /etc/apt/sources.list diff --git a/man/man1/git-secret-add.1 b/man/man1/git-secret-add.1 index 337aa89d..d94a2dd0 100644 --- a/man/man1/git-secret-add.1 +++ b/man/man1/git-secret-add.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\-add\fR \- starts to track added files\. diff --git a/man/man1/git-secret-add.1.ronn b/man/man1/git-secret-add.1.md similarity index 100% rename from man/man1/git-secret-add.1.ronn rename to man/man1/git-secret-add.1.md diff --git a/man/man1/git-secret-cat.1 b/man/man1/git-secret-cat.1 index 239082f1..a899a34f 100644 --- a/man/man1/git-secret-cat.1 +++ b/man/man1/git-secret-cat.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\-cat\fR \- decrypts files passed on command line to stdout diff --git a/man/man1/git-secret-cat.1.ronn b/man/man1/git-secret-cat.1.md similarity index 100% rename from man/man1/git-secret-cat.1.ronn rename to man/man1/git-secret-cat.1.md diff --git a/man/man1/git-secret-changes.1 b/man/man1/git-secret-changes.1 index 4e4e3748..b8075203 100644 --- a/man/man1/git-secret-changes.1 +++ b/man/man1/git-secret-changes.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\-changes\fR \- view diff of the hidden files\. diff --git a/man/man1/git-secret-changes.1.ronn b/man/man1/git-secret-changes.1.md similarity index 100% rename from man/man1/git-secret-changes.1.ronn rename to man/man1/git-secret-changes.1.md diff --git a/man/man1/git-secret-clean.1 b/man/man1/git-secret-clean.1 index 39259469..75776ab0 100644 --- a/man/man1/git-secret-clean.1 +++ b/man/man1/git-secret-clean.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\-clean\fR \- removes all the hidden files\. diff --git a/man/man1/git-secret-clean.1.ronn b/man/man1/git-secret-clean.1.md similarity index 100% rename from man/man1/git-secret-clean.1.ronn rename to man/man1/git-secret-clean.1.md diff --git a/man/man1/git-secret-hide.1 b/man/man1/git-secret-hide.1 index 288b779e..75524218 100644 --- a/man/man1/git-secret-hide.1 +++ b/man/man1/git-secret-hide.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\-hide\fR \- encrypts all added files with the inner keyring\. diff --git a/man/man1/git-secret-hide.1.ronn b/man/man1/git-secret-hide.1.md similarity index 100% rename from man/man1/git-secret-hide.1.ronn rename to man/man1/git-secret-hide.1.md diff --git a/man/man1/git-secret-init.1 b/man/man1/git-secret-init.1 index 9ab47b05..4895cc00 100644 --- a/man/man1/git-secret-init.1 +++ b/man/man1/git-secret-init.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\-init\fR \- initializes git\-secret repository\. diff --git a/man/man1/git-secret-init.1.ronn b/man/man1/git-secret-init.1.md similarity index 100% rename from man/man1/git-secret-init.1.ronn rename to man/man1/git-secret-init.1.md diff --git a/man/man1/git-secret-killperson.1 b/man/man1/git-secret-killperson.1 index c129073b..cd9860d2 100644 --- a/man/man1/git-secret-killperson.1 +++ b/man/man1/git-secret-killperson.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\-killperson\fR \- deletes key identified by an email from the inner keyring\. diff --git a/man/man1/git-secret-killperson.1.ronn b/man/man1/git-secret-killperson.1.md similarity index 100% rename from man/man1/git-secret-killperson.1.ronn rename to man/man1/git-secret-killperson.1.md diff --git a/man/man1/git-secret-list.1 b/man/man1/git-secret-list.1 index 8c10de70..e90e935a 100644 --- a/man/man1/git-secret-list.1 +++ b/man/man1/git-secret-list.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\-list\fR \- prints all the added files\. diff --git a/man/man1/git-secret-list.1.ronn b/man/man1/git-secret-list.1.md similarity index 100% rename from man/man1/git-secret-list.1.ronn rename to man/man1/git-secret-list.1.md diff --git a/man/man1/git-secret-remove.1 b/man/man1/git-secret-remove.1 index e808821b..2a5219bd 100644 --- a/man/man1/git-secret-remove.1 +++ b/man/man1/git-secret-remove.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\-remove\fR \- removes files from index\. diff --git a/man/man1/git-secret-remove.1.ronn b/man/man1/git-secret-remove.1.md similarity index 100% rename from man/man1/git-secret-remove.1.ronn rename to man/man1/git-secret-remove.1.md diff --git a/man/man1/git-secret-reveal.1 b/man/man1/git-secret-reveal.1 index efce3d62..e7fd5de8 100644 --- a/man/man1/git-secret-reveal.1 +++ b/man/man1/git-secret-reveal.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\-reveal\fR \- decrypts all added files\. diff --git a/man/man1/git-secret-reveal.1.ronn b/man/man1/git-secret-reveal.1.md similarity index 100% rename from man/man1/git-secret-reveal.1.ronn rename to man/man1/git-secret-reveal.1.md diff --git a/man/man1/git-secret-tell.1 b/man/man1/git-secret-tell.1 index 22d5ce37..447055a4 100644 --- a/man/man1/git-secret-tell.1 +++ b/man/man1/git-secret-tell.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\-tell\fR \- adds a person, who can access private data\. diff --git a/man/man1/git-secret-tell.1.ronn b/man/man1/git-secret-tell.1.md similarity index 100% rename from man/man1/git-secret-tell.1.ronn rename to man/man1/git-secret-tell.1.md diff --git a/man/man1/git-secret-usage.1 b/man/man1/git-secret-usage.1 index b97774f5..20d08330 100644 --- a/man/man1/git-secret-usage.1 +++ b/man/man1/git-secret-usage.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\-usage\fR \- prints all the available commands\. diff --git a/man/man1/git-secret-usage.1.ronn b/man/man1/git-secret-usage.1.md similarity index 100% rename from man/man1/git-secret-usage.1.ronn rename to man/man1/git-secret-usage.1.md diff --git a/man/man1/git-secret-whoknows.1 b/man/man1/git-secret-whoknows.1 index 9deb765f..1e8ae4ec 100644 --- a/man/man1/git-secret-whoknows.1 +++ b/man/man1/git-secret-whoknows.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\-whoknows\fR \- prints email\-labels for each key in the keyring\. diff --git a/man/man1/git-secret-whoknows.1.ronn b/man/man1/git-secret-whoknows.1.md similarity index 100% rename from man/man1/git-secret-whoknows.1.ronn rename to man/man1/git-secret-whoknows.1.md diff --git a/man/man7/git-secret.7 b/man/man7/git-secret.7 index 8f6f3567..7ba19cfd 100644 --- a/man/man7/git-secret.7 +++ b/man/man7/git-secret.7 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.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" \fBgit\-secret\fR \- bash tool to store private data inside a git repo\. diff --git a/man/man7/git-secret.7.ronn b/man/man7/git-secret.7.md similarity index 100% rename from man/man7/git-secret.7.ronn rename to man/man7/git-secret.7.md diff --git a/utils/build-utils.sh b/utils/build-utils.sh index ddae9e82..13fac90b 100755 --- a/utils/build-utils.sh +++ b/utils/build-utils.sh @@ -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/man7" for file in man/man1/* ; do - if [[ "$file" == *.ronn ]]; then + if [[ "$file" == *.md ]]; then continue fi