FilesExpand file tree

 main

/

GenDocs.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

78 lines (64 loc) · 2.78 KB

 main

/

GenDocs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

78 lines (64 loc) · 2.78 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

name: Generate PyDocs

on:

push:

tags:

- 'v*'

jobs:

build-and-deploy:

runs-on: ubuntu-latest

steps:

- name: Checkout code from main branch

uses: actions/checkout@v3

with:

ref: main

repository: ${{ github.repository }}

- name: Set up Python

uses: actions/setup-python@v2

with:

python-version: '3.11'

- name: Install dependencies

run: |

python -m pip install --upgrade pip

pip install pdoc

pip install --upgrade py2app

pip install python-dotenv

pip install -r requirements.txt

- name: Get the current tag name

run: echo "TAG_NAME=${GITHUB_REF##*/}" >> "$GITHUB_ENV"

# New Step: Extracting Major Version Number

- name: Set the current major version

run: echo "MAJOR_VERSION=$(echo $TAG_NAME | cut -d '.' -f 1)" >> "$GITHUB_ENV" # This extracts the major version assuming a 'vX.Y.Z' format

- name: Checkout the gh-pages branch

uses: actions/checkout@v3

with:

ref: gh-pages

path: gh-pages

- name: Generate Documentation for the current tag

run: |

ROOT_PATH=$(pwd) # Moved this line up to ensure ROOT_PATH is set before its usage

rm -rf $ROOT_PATH/gh-pages/docs/$MAJOR_VERSION

mkdir -p $ROOT_PATH/gh-pages/docs/$MAJOR_VERSION # Note: Changed to use MAJOR_VERSION to create/update the major version folder

cd $ROOT_PATH/deepgram

pdoc $ROOT_PATH/deepgram -o $ROOT_PATH/gh-pages/docs/$MAJOR_VERSION # Documentation is generated/updated in the major version folder

- name: Deploy to GitHub Pages

uses: peaceiris/actions-gh-pages@v3

with:

github_token: ${{ secrets.GITHUB_TOKEN }}

publish_dir: ./gh-pages

publish_branch: gh-pages

keep_files: true

- name: Print the GitHub Pages URL for the current tag

run: |

echo "Documentation URL for $TAG_NAME: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/docs/$MAJOR_VERSION/index.html"

- name: Wait for GitHub Pages to become ready

run: sleep 60

- name: Check documentation availability for the current tag

run: |

URL="https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/docs/$MAJOR_VERSION/index.html"

HTTP_STATUS=$(curl -o /dev/null -s -w "%{http_code}\n" "$URL")

if [ "$HTTP_STATUS" != "200" ]; then

echo "Documentation for $TAG_NAME not available yet, actual HTTP status: $HTTP_STATUS"

exit 1

else

echo "Documentation for $TAG_NAME is successfully published and available."

fi