Skip to content

Commit

Permalink
update doc build
Browse files Browse the repository at this point in the history
  • Loading branch information
pwelter34 committed Jan 10, 2024
1 parent 89287de commit 34c6373
Show file tree
Hide file tree
Showing 4 changed files with 101 additions and 39 deletions.
58 changes: 58 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Documentation

on:
push:
branches:
- master
- develop
tags:
- 'v*'
paths:
- 'docs/**'
- 'mkdocs.yml'

permissions:
contents: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: 3.x

- name: Install mkdocs
run: pip install mkdocs-material

- name: Build Documentation
run: mkdocs build

- name: Upload Documentation
if: success()
uses: actions/upload-pages-artifact@v2
with:
name: github-pages
path: 'site/'

pages:
runs-on: ubuntu-latest
needs: build
if: success()

permissions:
pages: write
id-token: write

steps:
- name: Deploy Documentation
id: deployment
uses: actions/deploy-pages@v2

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
26 changes: 11 additions & 15 deletions .github/workflows/dotnet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ on:
- develop
tags:
- 'v*'
paths-ignore:
- 'docs/**'
- 'mkdocs.yml'
pull_request:
branches:
- master
Expand All @@ -25,12 +28,12 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Install .NET Core
uses: actions/setup-dotnet@v3
- name: Install .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: |
6.0.x
Expand All @@ -43,29 +46,22 @@ jobs:
run: dotnet build --no-restore --configuration Release

- name: Run Test
run: dotnet test --configuration Release --collect:"XPlat Code Coverage" --settings coverlet.runsettings

- name: Generate Coverage
uses: danielpalme/[email protected]
with:
reports: '${{github.workspace}}/test/*/TestResults/*/coverage.info'
targetdir: ${{env.BUILD_PATH}}
reporttypes: lcov
run: dotnet test --no-build --configuration Release --collect:"XPlat Code Coverage" --settings coverlet.runsettings

- name: Report Coverage
if: success()
uses: coverallsapp/github-action@v2
with:
file: artifacts/lcov.info
format: lcov
file: "${{github.workspace}}/test/*/TestResults/*/coverage.info"
format: lcov

- name: Create Packages
if: success() && github.event_name != 'pull_request'
run: dotnet pack --configuration Release --include-symbols --include-source --no-build --no-restore --output "${{env.BUILD_PATH}}"

- name: Upload Packages
if: success() && github.event_name != 'pull_request'
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: packages
path: '${{env.BUILD_PATH}}'
Expand All @@ -77,7 +73,7 @@ jobs:

steps:
- name: Download Artifact
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
name: packages

Expand Down
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ Application start-up helper to initialize things like an IoC container, register

[![Build status](https://github.com/loresoft/KickStart/workflows/Build/badge.svg)](https://github.com/loresoft/KickStart/actions)

[![Documentation Status](https://readthedocs.org/projects/kickstart/badge/?version=latest)](http://kickstart.readthedocs.io/en/latest/?badge=latest)

[![Coverage Status](https://coveralls.io/repos/github/loresoft/KickStart/badge.svg?branch=master)](https://coveralls.io/github/loresoft/KickStart?branch=master)

| Package | Version |
Expand Down
54 changes: 32 additions & 22 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,29 +1,39 @@
site_name: KickStart
theme: readthedocs
theme: material
repo_url: https://github.com/loresoft/KickStart

pages:
- Home: index.md
nav:
- Home: index.md

- Configuration: configuration.md
- Usage: usage.md
- Configuration: configuration.md
- Usage: usage.md

- Startup Task: startup.md
- AutoMapper: automapper.md
- MongoDB: mongoDB.md
- Startup Task: startup.md
- AutoMapper: automapper.md
- MongoDB: mongoDB.md

- Dependency Injection:
- Generic Registration: di/registration.md
- Autofac: di/autofac.md
- DependencyInjection: di/dependencyInjection.md
- Ninject: di/ninject.md
- SimpleInjector: di/simpleInjector.md
- Unity: di/unity.md
- Dependency Injection:
- Generic Registration: di/registration.md
- Autofac: di/autofac.md
- DependencyInjection: di/dependencyInjection.md
- Ninject: di/ninject.md
- SimpleInjector: di/simpleInjector.md
- Unity: di/unity.md

- Database Deployment:
- Usage: db/database.md
- Sql Server: db/sqlServer.md
- PostgreSQL: db/postgreSQL.md
- MySql: db/mySql.md
- Sqlite: db/sqlite.md
- MongoDB: db/mongoDB.md
- Database Deployment:
- Usage: db/database.md
- Sql Server: db/sqlServer.md
- PostgreSQL: db/postgreSQL.md
- MySql: db/mySql.md
- Sqlite: db/sqlite.md
- MongoDB: db/mongoDB.md

markdown_extensions:
- tables
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences

0 comments on commit 34c6373

Please sign in to comment.