Skip to content

Commit

Permalink
generate pdf on CI
Browse files Browse the repository at this point in the history
  • Loading branch information
parvit committed Aug 21, 2024
1 parent 5ac3db4 commit bd75bc4
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 4 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ jobs:
env:
GO_VERSION: 1.20.14
PANDOC_VERSION: 3.3
TEST_VER: 0.5.0

steps:
- uses: actions/checkout@v4
Expand All @@ -41,6 +42,8 @@ jobs:
- name: Generate PDF
run: |
cd docs/
sed -E 's/subtitle:.+/subtitle: "User Manual - version ${{ env.TEST_VER }}"/' user-manual.md > user-manual.md
sed -E 's/date:.+/date: "${date \'+%x %T\'}"/' user-manual.md > user-manual.md
go generate
- uses: actions/upload-artifact@v4
Expand Down
44 changes: 43 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -249,8 +249,50 @@ jobs:
check_name: "Unit Tests - Windows Platform"
junit_files: "unit/*.xml"

docs:
if: true
runs-on: ubuntu-latest
defaults:
run:
shell: bash

env:
GO_VERSION: 1.20.14
PANDOC_VERSION: 3.3

steps:
- uses: actions/checkout@v4
with:
clean: true
submodules: false

- name: Install Pandoc
uses: pandoc/actions/[email protected]
with:
version: ${{ env.PANDOC_VERSION }}

- name: Install TeXlive
run: sudo apt-get update && sudo apt-get install texlive-small

- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: ${{ env.GO_VERSION }}

- name: Generate PDF
run: |
cd docs/
sed -E 's/subtitle:.+/subtitle: "User Manual - version ${{ github.event.inputs.version_tag }}"/' user-manual.md > user-manual.md
sed -E 's/date:.+/date: "${date \'+%x %T\'}"/' user-manual.md > user-manual.md
go generate
- uses: actions/upload-artifact@v4
with:
name: qpep_user_manual
path: "docs/*.pdf"

create-release-tag:
needs: [build-windows, build-linux]
needs: [build-windows, build-linux, docs]
runs-on: ubuntu-latest
defaults:
run:
Expand Down
4 changes: 1 addition & 3 deletions docs/user-manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,6 @@ Both methods do seamlessly bridge, in the form of QUIC streams, the TCP connecti

Once this stream is received on the server, a connection to the original destination of the TCP connection is opened and the request is executed and the data exchanged as if the tunnel was not there at all.

\newpage

The following image exposes schematically the architecture for QPep:

![Architecture of QPep](intro_scheme.png){ width=350pt }
Expand Down Expand Up @@ -78,7 +76,7 @@ The benefits of using the QUIC protocol over UDP are too numerous to list here,
* **_Adaptability to differing MTU conditions_** as the QUIC packets are usually sent to the MTU size of the
connection and is automatically adapted if sent packets are detected as lost

\bigskip
\newpage

QPep supports different backend implementations of the QUIC protocol at the moment:

Expand Down

0 comments on commit bd75bc4

Please sign in to comment.