diff --git a/.github/workflows/pdf.yml b/.github/workflows/pdf.yml index 32bfc565..12273c38 100644 --- a/.github/workflows/pdf.yml +++ b/.github/workflows/pdf.yml @@ -1,6 +1,7 @@ name: Generate PDF on: + workflow_dispatch: release: types: [published] @@ -8,17 +9,40 @@ jobs: generate: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 + - name: Change absolute paths to relative run: perl -pi -e 's@\]\(\/@\]\(@' _sidebar.md - - uses: actions/setup-node@v1 + + - uses: actions/setup-node@v4 with: - node-version: '12' - - name: Install converter + uploader - run: npm install docsify-pdf-converter @iomeg/zenodo-upload - - name: Generate PDF - run: npx docsify-pdf-converter + node-version: '20' + + - name: Install uploader + run: npm install @iomeg/zenodo-upload + + - name: Pull Docker image + run: docker pull ghcr.io/kernoeb/docker-docsify-pdf:latest + + - name: Generate PDF using the Docker image + run: | + docker run --rm --privileged \ + -v "${{ github.workspace }}/":/home/node/docs:rw \ + -v "${{ github.workspace }}/":/home/node/pdf:rw \ + -v "${{ github.workspace }}/images/pdf-cover.pdf":/home/node/resources/cover.pdf:rw \ + --user $(id -u):$(id -g) \ + -e "PDF_OUTPUT_NAME=guide-nlesc.pdf" \ + ghcr.io/kernoeb/docker-docsify-pdf:latest + + - name: Upload PDF as an artifact + if: always() + uses: actions/upload-artifact@v4 + with: + name: generated-pdf + path: guide-nlesc.pdf + - name: Upload PDF to Zenodo + if: github.event_name == 'release' run: npx --package @iomeg/zenodo-upload zenodo_upload 4020565 guide-nlesc.pdf "${github_ref:10}" ${{ secrets.ZENODO_TOKEN }} env: github_ref: ${{ github.ref }} diff --git a/.gitignore b/.gitignore index d303b284..8e318a70 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,11 @@ # files for JetBrains editors: **/*.iml .idea + +# VS Code +.vscode + +# Mac OS +.DS_Store + + diff --git a/CITATION.cff b/CITATION.cff index a66c40d0..d3b77d19 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -162,3 +162,7 @@ authors: - affiliation: "Netherlands eScience Center" family-names: Cushing given-names: Reggie + - affiliation: "Netherlands eScience Center" + family-names: Kasalica + given-names: Vedran + orcid: "https://orcid.org/0000-0002-0097-1056" diff --git a/images/pdf-cover.pdf b/images/pdf-cover.pdf new file mode 100644 index 00000000..d7a7d206 Binary files /dev/null and b/images/pdf-cover.pdf differ diff --git a/technology/technology_overview.md b/technology/technology_overview.md index 36dcbea0..bfffda11 100644 --- a/technology/technology_overview.md +++ b/technology/technology_overview.md @@ -1,3 +1,5 @@ +# Technology Guides + *Page maintainer: Patrick Bos* [@egpbos](https://github.com/egpbos) These chapters are based on our experiences with using specific software technologies.