![]() This extension doesn't works with Hosted build agent as of now.Added support for using custom doxyfile.coverage - name: Copy Coverage To Predictable Location run: cp coverage/**/ - name: Coverage Summary Report uses: with: filename: bertura. x - name: Restore Dependencies run: dotnet restore src/DocFXExample.sln - name: Build run: dotnet build src/DocFXExample.sln -configuration Release -no-restore - name: Test run: dotnet test src/DocFXExample.sln -configuration Release -no-build -verbosity normal -collect:"XPlat Code Coverage" -results-directory. NET CLI telemetry jobs: build: runs-on: ubuntu-latest name: Release Build steps: - name: Checkout uses: - name: Setup. NET first time experience to speed up the build DOTNET_CLI_TELEMETRY_OPTOUT: true # Disable sending. NET logo DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true # Disable the. Workflow_dispatch: env: DOTNET_NOLOGO: true # Disable the. name: Build + Deploy on: release: types: Like the previous workflow it checks out the repo, builds the documentation and publishes it to GitHub Pages. It will only run if both the build and deploy-nuget jobs are successful. The final job deploy-docs is a copy of our Documentation Build workflow. Or it would in a real project, since this is just an example I've left out the steps to deploy the package to, GitHub Packages or another package feed. It gets the artifact from the previous step, publishes the Nuget package and adds the test coverage report to the release notes. ![]() The deploy-nuget job only runs if the build job was successful. It checks out the repo, builds and tests the code and uploads the Nuget and test coverage report as an artifact. The first job build is a slightly simplified version of our CI Build workflow. Triggered whenever a pre-release or full release is published it consists of three jobs that run sequentially. Release-build.yml is where we put everything together. docs to make publishing to GitHub Pages easier: publish_dir. We also need to change the output folder dest from _site to. We need to tell DocFX where to find our code by updating the src property in the metadata section of the configuration file docfx.json. api/index.md - index page for API documentation.index.md - home page for the generated site. ![]() The documentation project contains several files and folders we can use to customise the generated documentation: This generates a documentation project named docfx_project. In the root of the repo type the command:
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |