You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
75 lines
2.0 KiB
YAML
75 lines
2.0 KiB
YAML
name: "DocFX Setup"
|
|
description: ""
|
|
inputs:
|
|
github-token:
|
|
description: ''
|
|
default: ''
|
|
|
|
docs-directory:
|
|
description: ''
|
|
default: '$PWD/docs'
|
|
|
|
docfx-version:
|
|
description: ''
|
|
default: '2.74.1'
|
|
|
|
newtonsoftjson-version:
|
|
description: ''
|
|
default: '13.0.1'
|
|
|
|
runs:
|
|
using: "composite"
|
|
steps:
|
|
- name: Checkout Repository
|
|
uses: actions/checkout@v3
|
|
with:
|
|
submodules: recursive
|
|
fetch-depth: 0
|
|
|
|
- name: Setup .NET 8
|
|
uses: actions/setup-dotnet@master
|
|
with:
|
|
dotnet-version: 8.x.x
|
|
|
|
- name: Setup BUTR GPR
|
|
uses: actions/setup-dotnet@master
|
|
with:
|
|
source-url: https://nuget.pkg.github.com/BUTR/index.json
|
|
env:
|
|
NUGET_AUTH_TOKEN: ${{inputs.github-token}}
|
|
|
|
- name: Generating Newtonsoft.Json xref maps
|
|
run: >-
|
|
dotnet run --project ${{ github.action_path }}/build/SandcastleXrefGenerator -- `
|
|
Newtonsoft.Json ${{inputs.newtonsoftjson-version}} netstandard2.0 `
|
|
https://www.newtonsoft.com/json/help/html/ `
|
|
${{inputs.docs-directory}}/xrefs/Newtonsoft.Json-xrefmap.yml
|
|
shell: pwsh
|
|
|
|
- name: Build DocFx.Plugin.LastModified
|
|
run: dotnet publish ${{ github.action_path }}/build/DocFx.Plugin.LastModified --configuration Release --output ${{inputs.docs-directory}}/_template/last-modified/plugins;
|
|
shell: pwsh
|
|
|
|
# When a custom fork is needed
|
|
# - uses: actions/checkout@v3
|
|
# with:
|
|
# repository: BUTR/docfx
|
|
# path: _actions_docfx
|
|
# - uses: actions/setup-node@v4
|
|
# with:
|
|
# node-version: 16
|
|
# - run: npm install
|
|
# working-directory: _actions_docfx/templates
|
|
# shell: pwsh
|
|
# - run: npm run build
|
|
# working-directory: _actions_docfx/templates
|
|
# shell: pwsh
|
|
# - run: dotnet pack _actions_docfx/src/docfx -c Release -o _actions_docfx/drop/nuget
|
|
# shell: pwsh
|
|
# - run: dotnet tool update --global docfx
|
|
# working-directory: _actions_docfx
|
|
# shell: pwsh
|
|
- name: Install DocFX
|
|
run: dotnet tool update -g docfx
|
|
shell: pwsh
|