Adds new manual generation process

.github/workflows/test.yml

@@ -8,6 +8,15 @@ on:
   workflow_dispatch:
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install shellcheck
+      run: sudo apt-get update && sudo apt-get install -y shellcheck make
+    - name: Run lint
+      run: make lint
+
   docker-ci:
     runs-on: ubuntu-latest
     strategy:
@@ -21,17 +30,13 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-
     - name: Run checks
       run: GITSECRET_DOCKER_ENV="${{ matrix.docker-based-test }}" make ci
 
-  lint:
+  build-man:
     runs-on: ubuntu-latest
+
     steps:
     - uses: actions/checkout@v2
-
-    - name: Install shellcheck
-      run: sudo apt-get update && sudo apt-get install -y shellcheck make
-
-    - name: Run lint
-      run: make lint
+    - name: Checks that manual generation works
+      run: make build-man

Makefile

@@ -51,30 +51,48 @@ test: clean build
 # 3. We execute `make test` inside the `docker` container
 .PHONY: ci
 ci: clean
-	docker build -f ".ci/docker/$${GITSECRET_DOCKER_ENV}/Dockerfile" -t "$${GITSECRET_DOCKER_ENV}:latest" .
-	docker run --rm --volume="$${PWD}:/code" -w /code "$${GITSECRET_DOCKER_ENV}" make test
+	docker build \
+		-f ".ci/docker/$${GITSECRET_DOCKER_ENV}/Dockerfile" \
+		-t "gitsecret-$${GITSECRET_DOCKER_ENV}:latest" \
+		.
+	docker run --rm \
+		--volume="$${PWD}:/code" \
+		-w /code \
+		"gitsecret-$${GITSECRET_DOCKER_ENV}" \
+		make test
 
 .PHONY: lint
 lint:
-	find src/ .ci/ utils/ -type f -name '*.sh' -print0 | xargs -0 -I {} shellcheck {}
-	find tests/ -type f -name '*.bats' -o -name '*.bash' -print0 | xargs -0 -I {} shellcheck {}
+	find src/ .ci/ utils/ -type f \
+		-name '*.sh' -print0 | xargs -0 -I {} shellcheck {}
+	find tests/ -type f -name '*.bats' \
+		-o -name '*.bash' -print0 | xargs -0 -I {} shellcheck {}
 
 #
 # Manuals:
 #
 
-.PHONY: install-ronn
-install-ronn:
-	if [ ! `gem list ronn -i` == "true" ]; then gem install ronn; fi
-
 .PHONY: clean-man
 clean-man:
-	find "man/" -type f ! -name "*.ronn" -delete
+	find "man/" -type f -name "*.roff" -delete
 
 .PHONY: build-man
-build-man: install-ronn clean-man git-secret
+build-man: clean-man git-secret
+	# Prepare:
 	touch man/*/*.ronn
-	export GITSECRET_VERSION=`./git-secret --version` && ronn --roff --organization="sobolevn" --manual="git-secret $${GITSECRET_VERSION}" man/*/*.ronn
+
+	# Build docker image:
+	docker pull msoap/ruby-ronn
+
+	# Do the manual generation:
+	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
 
 #
 # Packaging:

README.md

@@ -1,6 +1,9 @@
 # git-secret
 
-[![Backers on Open Collective](https://opencollective.com/git-secret/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/git-secret/sponsors/badge.svg)](#sponsors) [![Build Status](https://img.shields.io/travis/sobolevn/git-secret/master.svg)](https://travis-ci.org/sobolevn/git-secret) [![Homebrew](https://img.shields.io/homebrew/v/git-secret.svg)](https://formulae.brew.sh/formula/git-secret) [![Bintray deb](https://img.shields.io/bintray/v/sobolevn/deb/git-secret.svg)](https://bintray.com/sobolevn/deb/git-secret/view)
+[![Backers on Open Collective](https://opencollective.com/git-secret/backers/badge.svg)](#backers)
+[![Sponsors on Open Collective](https://opencollective.com/git-secret/sponsors/badge.svg)](#sponsors)
+[![test](https://github.com/sobolevn/git-secret/actions/workflows/test.yml/badge.svg?branch=master&event=push)](https://github.com/sobolevn/git-secret/actions/workflows/test.yml)
+[![Homebrew](https://img.shields.io/homebrew/v/git-secret.svg)](https://formulae.brew.sh/formula/git-secret)
 
 [![git-secret](https://raw.githubusercontent.com/sobolevn/git-secret/gh-pages/images/git-secret-big.png)](http://git-secret.io/)
 

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET\-ADD" "1" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\-add\fR \- starts to track added files\.

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET\-CAT" "1" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\-cat\fR \- decrypts files passed on command line to stdout

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET\-CHANGES" "1" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\-changes\fR \- view diff of the hidden files\.

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET\-CLEAN" "1" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\-clean\fR \- removes all the hidden files\.

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET\-HIDE" "1" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\-hide\fR \- encrypts all added files with the inner keyring\.

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET\-INIT" "1" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\-init\fR \- initializes git\-secret repository\.

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET\-KILLPERSON" "1" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\-killperson\fR \- deletes key identified by an email from the inner keyring\.

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET\-LIST" "1" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\-list\fR \- prints all the added files\.

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET\-REMOVE" "1" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\-remove\fR \- removes files from index\.

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET\-REVEAL" "1" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\-reveal\fR \- decrypts all added files\.

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET\-TELL" "1" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\-tell\fR \- adds a person, who can access private data\.

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET\-USAGE" "1" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\-usage\fR \- prints all the available commands\.

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET\-WHOKNOWS" "1" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\-whoknows\fR \- prints email\-labels for each key in the keyring\.

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" "April 2021" "sobolevn" "git-secret 0.3.3"
+.TH "GIT\-SECRET" "7" "May 2021" "sobolevn" "git-secret "
 .
 .SH "NAME"
 \fBgit\-secret\fR \- bash tool to store private data inside a git repo\.