Git/testssl.sh
1
0
Fork 0
mirror of https://github.com/drwetter/testssl.sh.git synced 2026-06-23 08:47:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3064 from testssl/automate_pandoc

Browse Source 
Automate pandoc
This commit is contained in:
Dirk Wetter
2026-06-17 11:24:25 +02:00
committed by GitHub
parent e0af44a7be f8c23ab69f
commit 826449115c
4 changed files with 317 additions and 264 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/build_docs.yml
+43
View File
@@ -0,0 +1,43 @@
name: Build Documentation
on:
pull_request:
paths:
- "doc/testssl.1.md"
jobs:
build-docs:
runs-on: ubuntu-26.04
# Skip fork PRs: GITHUB_TOKEN can't push to a fork's branch
if: github.event.pull_request.head.repo.full_name == github.repository
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
fetch-depth: 0
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y pandoc make
- name: Build documentation
working-directory: doc
run: make -B
# -B ensures build when doc/testssl.1.md changes. When checking out the md file
# it probably might have a time stamp which indicates nothing has changed
- name: Commit and push generated doc files
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git add -A
if git diff --staged --quiet; then
echo "No generated changes to commit"
else
git commit -m "Auto-generate docs from testssl.1.md [skip ci]"
git push
fi
doc/testssl.1
+263 -252
View File
File diff suppressed because it is too large Load Diff
doc/testssl.1.html
+9 -10
View File
@@ -43,7 +43,7 @@
</head>
<body>
<h2 id="name">NAME</h2>
<p>testssl.sh – check encryption of SSL/TLS servers</p>
<p>testssl.sh – check TLS/SSL encryption of servers</p>
<h2 id="synopsis">SYNOPSIS</h2>
<p><code>testssl.sh [OPTIONS] &lt;URI&gt;</code>,
<code>testssl.sh [OPTIONS] --file &lt;FILE&gt;</code></p>
@@ -921,11 +921,11 @@
and when this is set to true, it generates a separate text file
with epoch times in <code>/tmp/testssl-&lt;XX&gt;.time</code>.
They need to be concatenated by
<code>paste /tmp/testssl-&lt;XX&gt;.{time,log}</code> <!---
* FAST_SOCKET
* SHOW_SIGALGO
* FAST
--></li>
<code>paste /tmp/testssl-&lt;XX&gt;.{time,log}</code>
&lt;!—</li>
<li>FAST_SOCKET</li>
<li>SHOW_SIGALGO</li>
<li>FAST –&gt;</li>
<li>EXPERIMENTAL=true is an option which is sometimes used in
the development process to make testing easier. In released
versions this has no effect.</li>
@@ -965,10 +965,9 @@
may be made larger on systems with faster processors.</li>
<li>MAX_WAIT_TEST is the maximum time (in seconds) to wait for a
single test in parallel mass testing mode to complete. The
default is 1200. <!---
* USLEEP_SND
* USLEEP_REC
--></li>
default is 1200. &lt;!—</li>
<li>USLEEP_SND</li>
<li>USLEEP_REC –&gt;</li>
<li>HSTS_MIN is preset to 179 (days). If you want warnings
sooner or later for HTTP Strict Transport Security you can
change this.</li>
doc/testssl.1.md
+2 -2
View File
@@ -1,6 +1,6 @@
## NAME
testssl.sh -- check encryption of SSL/TLS servers
testssl.sh -- check TLS/SSL encryption of servers
## SYNOPSIS
@@ -36,7 +36,7 @@ linked OpenSSL binaries for major operating systems are supplied in `./bin/`.
`testssl.sh URI` as the default invocation does the so-called default run which does a number of checks and puts out the results colorized (ANSI and termcap) on the screen. It does every check listed below except `-E` which are (order of appearance):
0) displays a banner (see below), does a DNS lookup also for further IP addresses and does for the returned IP address a reverse lookup. Last but not least a service check is being done.
0) displays a banner (see below), does a DNS lookup also for further IP addresses and does for the returned IP address a reverse lookup. Last but not least a service check is being done.
1) SSL/TLS protocol check