Skip to content

Commit

Permalink
initial
Browse files Browse the repository at this point in the history
  • Loading branch information
tig committed Dec 3, 2023
1 parent 8684e82 commit 5f636f9
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .github/workflows/api-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Build and publish Terminal.Gui v2 API docs

on:
push:
branches: [main]

permissions:
id-token: write
pages: write

jobs:
deploy:
name: Build and Deploy API docs to github-pages
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: windows-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Setup DocFX
uses: crazy-max/ghaction-chocolatey@v2
with:
args: install docfx

- name: DocFX Build
working-directory: docfx
run: |
git clone https://github.com/gui-cs/Terminal.Gui.git
cd Terminal.Gui
git checkout v2_develop
docfx ./docfx/docfx.json build
continue-on-error: false

- name: Setup Pages
uses: actions/configure-pages@v3

- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./Terminal.Gui/docfx/_site

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
14 changes: 14 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -396,3 +396,17 @@ FodyWeavers.xsd

# JetBrains Rider
*.sln.iml

# User-specific files
*.user

# API Docs
docfx/api

# Never push ./docs folder - the gh-pages branch is now used to publish to GH Pages
docs/

#git merge files
*.orig

*.tui/

0 comments on commit 5f636f9

Please sign in to comment.