Skip to content

Commit

Permalink
🙈
Browse files Browse the repository at this point in the history
  • Loading branch information
EthanThatOneKid committed Nov 23, 2023
1 parent f85ec47 commit 1f2502a
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
57 changes: 57 additions & 0 deletions .github/workflows/godoc_preview.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Generate Documentation Preview

on:
pull_request:
branches:
- "*"
push:
branches:
- "*"

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout Repository
uses: actions/checkout@v2

- name: Set up Go
uses: actions/setup-go@v2
with:
go-version: "1.21"

- name: Install godoc
run: go install -v golang.org/x/tools/cmd/godoc@latest

- name: Generate Documentation
run: |
godoc -http=:6060 & sleep 5
curl -sSf http://localhost:6060/pkg/ > path/to/generated/documentation/index.html
- name: Upload Documentation Preview
uses: actions/upload-artifact@v2
with:
name: documentation-preview
path: path/to/generated/documentation

deploy:
needs: build
runs-on: ubuntu-latest

steps:
- name: Download Documentation Preview
uses: actions/download-artifact@v2
with:
name: documentation-preview
path: path/to/generated/documentation

- name: Deploy Documentation Preview
run: |
# You can deploy the generated documentation preview to a hosting service
# For example, if you're using GitHub Pages:
mkdir -p docs
mv path/to/generated/documentation/* docs/${{ event.base_ref }}
git add docs
git commit -m "Update documentation preview"
git push origin HEAD
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@

# Go workspace file
go.work
db.sqlite

0 comments on commit 1f2502a

Please sign in to comment.