[Docs] Remove some redundant notes & small updates #14
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Deploy Docs | |
on: | |
push: | |
tags: | |
- '*' | |
paths: | |
- 'docs/**' | |
workflow_dispatch: | |
pull_request: | |
paths: | |
- 'docs/**' | |
branches: | |
- dev | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Setup .NET | |
uses: actions/setup-dotnet@v4 | |
with: | |
dotnet-version: 8.0.x | |
- name: Setup DocFX | |
run: dotnet tool install -g docfx --version 2.75.2 | |
- name: Build DNet docs | |
run: docfx docs/docfx.json | |
- name: Upload Artifacts | |
uses: actions/upload-artifact@v4 | |
with: | |
name: static-docs | |
path: docs/_site | |
deploy: | |
runs-on: ubuntu-latest | |
needs: build | |
if: startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch' | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v2 | |
- name: Download Artifacts | |
uses: actions/download-artifact@v2 | |
with: | |
name: static-docs | |
path: output/ | |
- name: Auth DNet bot | |
id: bot_auth | |
uses: machine-learning-apps/actions-app-token@master | |
with: | |
APP_PEM: ${{ secrets.DNET_BOT_PEM }} | |
APP_ID: ${{ secrets.DNET_BOT_ID }} | |
- name: Push to the Docs Repo | |
uses: cpina/github-action-push-to-another-repository@main | |
env: | |
API_TOKEN_GITHUB: ${{ steps.bot_auth.outputs.app_token }} | |
with: | |
source-directory: 'output' | |
destination-github-username: 'discord-net' | |
destination-repository-name: 'docs-static' | |
user-email: [email protected] | |
target-branch: master |