Skip to content

Address remaining v2-era community PRs: Podman parsing + UTF-8 CLI st… #12

Address remaining v2-era community PRs: Podman parsing + UTF-8 CLI st…

Address remaining v2-era community PRs: Podman parsing + UTF-8 CLI st… #12

Workflow file for this run

name: Deploy Documentation to GitHub Pages
on:
push:
branches:
- master
- main
paths:
- 'docs/**'
- 'FluentDocker/**'
- '.github/workflows/pages.yml'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: '10.0.x'
- name: Generate API reference from XML docs
run: |
# `dotnet publish` co-locates all transitive deps next to the dll;
# xmldocmd uses Assembly.LoadFrom under the hood and needs every
# referenced assembly resolvable at the same path. Without publish,
# only FluentDocker.dll would be in bin/Release/ and the loader
# would fail on Microsoft.Extensions.Logging.Abstractions etc.
dotnet publish FluentDocker/FluentDocker.csproj \
--configuration Release \
--framework net8.0 \
--output /tmp/fd-publish
dotnet tool install -g xmldocmd
mkdir -p docs/api-reference
xmldocmd /tmp/fd-publish/FluentDocker.dll docs/api-reference \
--source https://github.com/mariotoffia/FluentDocker/tree/master/FluentDocker \
--front-matter docs/_api-frontmatter.tpl \
--clean
- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.2'
bundler-cache: true
working-directory: docs
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4
- name: Build with Jekyll
run: |
cd docs
bundle install
bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
env:
JEKYLL_ENV: production
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/_site
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4