DeTTECT/.github/workflows/update_wiki_help_texts.yml at master · rabobank-cdc/DeTTECT · GitHub

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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
name: Update Wiki Help texts
on:
  push:
    branches: [ master ]
    paths:
      - 'dettect.py'
  workflow_dispatch:
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          token: ${{ secrets.PERSONAL_TOKEN }}

      - name: Checkout wiki code
        uses: actions/checkout@v3
        with:
          repository: ${{github.repository}}.wiki
          path: wiki

      - name: Set up Python 3.10
        uses: actions/setup-python@v2
        with:
          python-version: '3.10'

      - name: Install Python dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt

      - name: Update Help-texts.md markdown file
        run: |
          HELPFILE='wiki/Help-texts.md'

          TXT1="Below you will find all the help texts present in \`dettect.py\`:\n- [Main](#main)\n- [Editor](#editor)\n- [Datasource](#datasource)\n- [Visibility](#visibility)\n- [Detection](#detection)\n- [Group](#group)\n- [Generic](#generic)\n\n### Main\n\`python dettect.py -h\`\n\n\`\`\`"
          echo "${TXT1//'\n'/$'\n'}"  > $HELPFILE
          python dettect.py -h >> $HELPFILE

          TXT2="\`\`\`\n\n### Editor\n\`python dettect.py editor -h\`\n\n\`\`\`"
          echo "${TXT2//'\n'/$'\n'}"  >> $HELPFILE
          python dettect.py editor -h >> $HELPFILE

          TXT3="\`\`\`\n\n### Datasource\n\`python dettect.py datasource -h\`\n\n\`\`\`"
          echo "${TXT3//'\n'/$'\n'}"  >> $HELPFILE
          python dettect.py ds -h >> $HELPFILE

          TXT4="\`\`\`\n\n### Visibility\n\`python dettect.py visibility -h\`\n\n\`\`\`"
          echo "${TXT4//'\n'/$'\n'}"  >> $HELPFILE
          python dettect.py v -h >> $HELPFILE

          TXT5="\`\`\`\n\n### Detection\n\`python dettect.py detection -h\`\n\n\`\`\`"
          echo "${TXT5//'\n'/$'\n'}"  >> $HELPFILE
          python dettect.py d -h >> $HELPFILE

          TXT6="\`\`\`\n\n### Group\n\`python dettect.py group -h\`\n\n\`\`\`"
          echo "${TXT6//'\n'/$'\n'}"  >> $HELPFILE
          python dettect.py g -h >> $HELPFILE

          TXT7="\`\`\`\n\n### Generic\n\`python dettect.py generic -h\`\n\n\`\`\`"
          echo "${TXT7//'\n'/$'\n'}"  >> $HELPFILE
          python dettect.py ge -h >> $HELPFILE

          TXT8="\`\`\`"
          echo "${TXT8//'\n'/$'\n'}"  >> $HELPFILE

      - name: Check for changes
        id: changes
        working-directory: ./wiki
        run: |
          OUTPUT=`git status`
          echo ::set-output name=GIT_STATUS::${OUTPUT}
          echo $OUTPUT

      - name: Commit files (if applicable)
        if: contains(steps.changes.outputs.GIT_STATUS, 'modified')
        working-directory: ./wiki
        run: |
          git config --local user.email "action@github.com"
          git config --local user.name "GitHub Action"
          git add -A
          git commit -m "Update Wiki help texts"

      - name: Push changes (if applicable)
        if: contains(steps.changes.outputs.GIT_STATUS, 'modified')
        uses: SwiftDocOrg/github-wiki-publish-action@v1
        with:
          path: "wiki"
        env:
          GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_TOKEN }}