Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix API docs #310

Merged
merged 7 commits into from
Dec 18, 2023
Merged

Fix API docs #310

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d928c33
Fix API docs
frederikprijck Dec 18, 2023
642adb6
Deploy API docs automatically
frederikprijck Dec 18, 2023
5b8a23c
Update contributing guidelines
frederikprijck Dec 18, 2023
b1621c4
revert
frederikprijck Dec 18, 2023
82ebd39
Update CONTRIBUTING.md
frederikprijck Dec 18, 2023
c16e719
Update .github/workflows/publish.yml
frederikprijck Dec 18, 2023
fe0cf3c
Update .github/workflows/publish.yml
frederikprijck Dec 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 34 additions & 11 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,9 @@ jobs:
- name: Build
run: msbuild Auth0.OidcClient.All.sln -t:rebuild -verbosity:diag -property:Configuration=Release

- name: NuGet pack
run: |
nuget pack nuget/Auth0.OidcClient.Android.nuspec
nuget pack nuget/Auth0.OidcClient.AndroidX.nuspec
nuget pack nuget/Auth0.OidcClient.Core.nuspec
nuget pack nuget/Auth0.OidcClient.iOS.nuspec
nuget pack nuget/Auth0.OidcClient.UWP.nuspec
nuget pack nuget/Auth0.OidcClient.WinForms.nuspec
nuget pack nuget/Auth0.OidcClient.WPF.nuspec

- name: Install DocFX
run: dotnet tool install -g docfx

- name: Build docs
run: ./tools/build-docs.sh
shell: bash
Expand All @@ -69,6 +59,16 @@ jobs:
with:
name: docs
path: docs

- name: NuGet pack
run: |
nuget pack nuget/Auth0.OidcClient.Android.nuspec
nuget pack nuget/Auth0.OidcClient.AndroidX.nuspec
nuget pack nuget/Auth0.OidcClient.Core.nuspec
nuget pack nuget/Auth0.OidcClient.iOS.nuspec
nuget pack nuget/Auth0.OidcClient.UWP.nuspec
nuget pack nuget/Auth0.OidcClient.WinForms.nuspec
nuget pack nuget/Auth0.OidcClient.WPF.nuspec
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just switched order here as it makes more sense.


- uses: actions/upload-artifact@v3
with:
Expand All @@ -80,5 +80,28 @@ jobs:
env:
NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}

# Deploy job
deploy-docs:
# Add a dependency to the build job
frederikprijck marked this conversation as resolved.
Show resolved Hide resolved
needs: build
frederikprijck marked this conversation as resolved.
Show resolved Hide resolved

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
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 }}

# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v3 # or specific "vX.X.X" version tag for this action
with:
artifact_name: docs


5 changes: 5 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,8 @@ When contributing to this SDK, please:
- Maintain the existing minumum .NET framework/core support.
- Keep PRs focused and change the minimum number of lines to achieve your goal.
- Do not introduce breaking changes without prior discussion and approval.


### API documentation

As the API documentation requires a windows environment, it is built and deployed by running the correspondig GitHub Actions Workflow.
frederikprijck marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 2 additions & 2 deletions src/Auth0.OidcClient.Android/docs-source/docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"bin/Release/**/Auth0.OidcClient.dll",
"bin/Release/**/Auth0.OidcClient.Core.dll"
],
"cwd": "../"
"src": "../"
}
],
"dest": "api",
Expand All @@ -26,7 +26,7 @@
"bin/Release/**/mscorlib.dll",
"bin/Release/**/System*.dll"
],
"cwd": "../"
"src": "../"
}
]

Expand Down
4 changes: 2 additions & 2 deletions src/Auth0.OidcClient.Android/docs-source/docfx.local.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"bin/Release/**/Auth0.OidcClient.dll",
"bin/Release/**/Auth0.OidcClient.Core.dll"
],
"cwd": "../"
"src": "../"
}
],
"dest": "api",
Expand All @@ -26,7 +26,7 @@
"bin/Release/**/mscorlib.dll",
"bin/Release/**/System*.dll"
],
"cwd": "../"
"src": "../"
}
]

Expand Down
2 changes: 1 addition & 1 deletion src/Auth0.OidcClient.UWP/docs-source/docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"bin/Release/**/Auth0.OidcClient.dll",
"bin/Release/**/Auth0.OidcClient.Core.dll"
],
"cwd": "../"
"src": "../"
}
],
"dest": "api",
Expand Down
2 changes: 1 addition & 1 deletion src/Auth0.OidcClient.UWP/docs-source/docfx.local.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"bin/Release/**/Auth0.OidcClient.dll",
"bin/Release/**/Auth0.OidcClient.Core.dll"
],
"cwd": "../"
"src": "../"
}
],
"dest": "api",
Expand Down
2 changes: 1 addition & 1 deletion src/Auth0.OidcClient.WPF/docs-source/docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"bin/Release/**/Auth0.OidcClient.dll",
"bin/Release/**/Auth0.OidcClient.Core.dll"
],
"cwd": "../"
"src": "../"
}
],
"dest": "api",
Expand Down
2 changes: 1 addition & 1 deletion src/Auth0.OidcClient.WPF/docs-source/docfx.local.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"bin/Release/**/Auth0.OidcClient.dll",
"bin/Release/**/Auth0.OidcClient.Core.dll"
],
"cwd": "../"
"src": "../"
}
],
"dest": "api",
Expand Down
2 changes: 1 addition & 1 deletion src/Auth0.OidcClient.WinForms/docs-source/docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"bin/Release/**/Auth0.OidcClient.dll",
"bin/Release/**/Auth0.OidcClient.Core.dll"
],
"cwd": "../"
"src": "../"
}
],
"dest": "api",
Expand Down
2 changes: 1 addition & 1 deletion src/Auth0.OidcClient.WinForms/docs-source/docfx.local.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"bin/Release/**/Auth0.OidcClient.dll",
"bin/Release/**/Auth0.OidcClient.Core.dll"
],
"cwd": "../"
"src": "../"
}
],
"dest": "api",
Expand Down
2 changes: 1 addition & 1 deletion src/Auth0.OidcClient.iOS/docs-source/docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"bin/Release/**/Auth0.OidcClient.dll",
"bin/Release/**/Auth0.OidcClient.Core.dll"
],
"cwd": "../"
"src": "../"
}
],
"dest": "api",
Expand Down
2 changes: 1 addition & 1 deletion src/Auth0.OidcClient.iOS/docs-source/docfx.local.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"bin/Release/**/Auth0.OidcClient.dll",
"bin/Release/**/Auth0.OidcClient.Core.dll"
],
"cwd": "../"
"src": "../"
}
],
"dest": "api",
Expand Down
Loading