Skip to content

Add EDIParser architecture image to README #8

Add EDIParser architecture image to README

Add EDIParser architecture image to README #8

Workflow file for this run

name: Build and deploy DocFX documentation
on:
push:
branches:
- main
paths:
- "docs/**"
- "src/EDIParser.Core/**"
- ".github/workflows/docfx-pages.yml"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: github-pages
cancel-in-progress: false
jobs:
build:
name: Build DocFX site
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v7
- name: Set up .NET
uses: actions/setup-dotnet@v6
with:
dotnet-version: "8.0.x"
- name: Restore EDIParser Core
run: dotnet restore src/EDIParser.Core/EDIParser.Core.csproj
- name: Build EDIParser Core
run: >
dotnet build
src/EDIParser.Core/EDIParser.Core.csproj
--configuration Release
--no-restore
- name: Install DocFX
run: dotnet tool install --global docfx --version 2.78.5
- name: Build documentation
run: docfx docs/docfx.json
- name: Verify generated site
shell: bash
run: |
test -f docs/_site/index.html
echo "DocFX site generated successfully."
find docs/_site -maxdepth 2 -type f | sed -n '1,40p'
- name: Configure GitHub Pages
uses: actions/configure-pages@v5
- name: Upload GitHub Pages artifact
uses: actions/upload-pages-artifact@v4
with:
path: docs/_site
deploy:
name: Deploy GitHub Pages
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy documentation
id: deployment
uses: actions/deploy-pages@v4