File: deploy-docs.yml

package info (click to toggle)
python-pygraphviz 1.14-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 732 kB
  • sloc: ansic: 5,100; python: 2,669; makefile: 57
file content (66 lines) | stat: -rw-r--r-- 2,100 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
name: deploy

on:
  push:
    branches: [main]

jobs:
  documentation:
    # Do not attempt to deploy documentation in forks
    if: github.repository_owner == 'pygraphviz'

    runs-on: Ubuntu-22.04

    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"

      - name: Update apt-get
        run: sudo apt-get update

      - name: Install Graphviz
        run: sudo apt-get install graphviz graphviz-dev

      - name: Install TeX
        run: sudo apt-get install texlive texlive-latex-extra latexmk imagemagick ghostscript libfreetype6-dev gsfonts libmagickwand-dev

      - name: Install packages
        run: |
          pip install --upgrade pip wheel setuptools
          pip install -r requirements/doc.txt -r requirements/test.txt
          pip install .
          pip list

        # To set up a cross-repository deploy key:
        # 1. Create a key pair:
        #   `ssh-keygen -t ed25519 -C "pgz_doc_deploy_ci_bot@nomail"`
        # 2. Add the public key to the pygraphviz/documentation repo
        #   Settings -> Deploy keys -> Add new
        #   Make sure to check the "writeable" checkbox
        # 3. Add private key as a secret to pygraphviz/pygraphviz
        #   Settings -> Secrets -> New Repository Secret
        #   Make sure the name is the same as below, e.g. CI_DEPLOY_KEY
      - name: Install SSH agent
        if: github.ref == 'refs/heads/main'
        uses: webfactory/ssh-agent@v0.9.0
        with:
          ssh-private-key: ${{ secrets.CI_DEPLOY_KEY }}

      - name: Build docs
        if: github.ref == 'refs/heads/main'
        run: make -C doc/ html

      - name: Deploy docs
        if: github.ref == 'refs/heads/main'
        uses: JamesIves/github-pages-deploy-action@releases/v3
        with:
          GIT_CONFIG_NAME: gh-deploy-bot
          GIT_CONFIG_EMAIL: gh-deploy-bot@nomail
          FOLDER: doc/build/html
          REPOSITORY_NAME: pygraphviz/documentation
          BRANCH: gh-pages
          TARGET_FOLDER: latest
          SSH: true