Skip to content

Commit

Permalink
docfx testing another workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
Steinar Elgsæter committed Feb 15, 2024
1 parent ecffd1b commit 526f104
Show file tree
Hide file tree
Showing 2 changed files with 129 additions and 39 deletions.
122 changes: 83 additions & 39 deletions .github/workflows/docfx.yml
Original file line number Diff line number Diff line change
@@ -1,46 +1,90 @@
name: docfx
on: [push]
jobs:
build:
runs-on: ubuntu-latest
name: Generate and publish the docs
outputs:
output1: ${{ steps.artifact-upload-step.outputs.artifact-id }}
steps:
- uses: actions/checkout@v1
name: Checkout code
- uses: nunit/docfx-action@v2.4.0
name: Build Documentation
with:
args: docfx.json
- uses: actions/upload-artifact@v4
with:
name: github-pages
path: docs
deploy:
# Add a dependency to the build job
needs: build
name: docfx for GitHub Pages

on:
# Runs on pushes targeting the default branch
push:
branches:
- 'master'

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
actions: read # to read the artifact made by build
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Deploy to the github-pages environment
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest


runs-on: ubuntu-latest
#########################################
###### sator-imaging/docfx-pages ######
#########################################
steps:
# - name: Deploy to GitHub Pages
# id: deployment
# uses: actions/deploy-pages@v4
# with:
# artifact_name: ${{needs.build.outputs.output1}}
- name: Deploy to GitHub Pages
id: deployment
uses: actions/upload-pages-artifact@v3
with:
name: github-pages.zip

# for extensibility, docfx-pages does NOT checkout your repository.
# so you need to checkout manually prior to sator-imaging/docfx-pages.
- name: Checkout
uses: actions/checkout@v3


# after checkout, you can checkout another repo, copy logo image or
# other assets into '.docfx' folder to setup own docfx environment.
# note that images must be copied into '.docfx/images', 'images' or '.images'.


###### main ######

- uses: sator-imaging/docfx-pages@v1
id: deployment # required to show url in actions result page.
with:

# required options
# NOTE: double-quote (") cannot be used, backquote (`) must be escaped (\`).
app_name: 'Deploy Test'
site_title: 'Deploy Test using sator-imaging/docfx-pages'
site_footer: '<big>&times; Is HTML accepted?</big>'

# optional
class_members: 'separatePages' # 'separatePages' or 'samePage'
google_analytics: '' # empty to disable
define_symbols: '' # additional preprocessor symbols separated by ';'

# paths must be relative from .docfx folder.
# note that url works but only in top page. see sample website for detail.
site_logo: '<logo>.svg'
site_favicon: '<favicon>.svg'

# advanced options
# --> https://dotnet.github.io/docfx/docs/template.html?tabs=modern#custom-template
# main.js
# NOTE: double-quote (") cannot be used, backquote (`) must be escaped (\`).
main_js: |
export default {
defaultTheme: 'light',
showLightbox: (img) => true,
iconLinks: [
{
icon: 'github',
href: 'https://github.com/sator-imaging',
title: 'GitHub'
},
],
}
# main.css
# NOTE: double-quote (") cannot be used, backquote (`) must be escaped (\`).
main_css: |
46 changes: 46 additions & 0 deletions .github/workflows/docfx.yml.old
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: docfx
on: [push]
jobs:
build:
runs-on: ubuntu-latest
name: Generate and publish the docs
outputs:
output1: ${{ steps.artifact-upload-step.outputs.artifact-id }}
steps:
- uses: actions/checkout@v1
name: Checkout code
- uses: nunit/docfx-action@v2.4.0
name: Build Documentation
with:
args: docfx.json
- uses: actions/upload-artifact@v4
with:
name: github-pages
path: docs
deploy:
# Add a dependency to the build job
needs: build

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
actions: read # to read the artifact made by build
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest
steps:
# - name: Deploy to GitHub Pages
# id: deployment
# uses: actions/deploy-pages@v4
# with:
# artifact_name: ${{needs.build.outputs.output1}}
- name: Deploy to GitHub Pages
id: deployment
uses: actions/upload-pages-artifact@v3
with:
name: github-pages.zip

0 comments on commit 526f104

Please sign in to comment.