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.

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

Automatically create documentation and deploy to GitHub Pages #4

Merged
merged 2 commits into from
Oct 9, 2022

Conversation

rdeago
Copy link
Member

@rdeago rdeago commented Oct 9, 2022

Scope and purpose of changes

Every good library needs documentation.

This PR adds automatic creation of web-based documentation and deploying to GitHub Pages upon every non-preview release from the main branch.

Types of changes

  • Bug fix
  • Enhancement (new and/or improved behavior)
  • Other (please describe below)

Additions to Cake scripts and GitHub workflows.

Proposed changes / fixed issues

A new deploy-paged workflow is automatically dispatched by the Release Cake target immediately before publishing a release, provided that it is not a prerelease and the workflow runs on the main branch.

The new workflow:

  • uses DocFx to extract API documentation from XML comments;
  • uses DocFx to build the documentation site;
  • uses GitHub actions to deploy the site to GitHub pages.

All static parts of the documentation site (home page, TOC, etc.) still have their default contents. A subsequent PR will provide more sensible contents; for now, testing the new workflow has a higher priority.

Contributor's checklist

  • I have written tests for any provided enhancement
  • I have written regression tests for any provided bug fix
  • I have successfully run all tests on my machine
  • I have added and/or updated related documentation (if applicable)
  • I have updated the "Unreleased changes" section in CHANGELOG.md, according to the modifications I made

Signed-off-by: Riccardo De Agostini <me@riccar.do>
Signed-off-by: Riccardo De Agostini <me@riccar.do>
@rdeago rdeago self-assigned this Oct 9, 2022
@rdeago
Copy link
Member Author

rdeago commented Oct 9, 2022

Can't review a PR I opened myself. Disappointing, if you ask me.

@rdeago
Copy link
Member Author

rdeago commented Oct 9, 2022

I'm going to test Squash and Merge with this PR. 🤞

@rdeago rdeago merged commit 339ac47 into Tenacom:main Oct 9, 2022
@rdeago rdeago deleted the publish-docs branch October 9, 2022 22:58
@rdeago rdeago added area:build [issue/PR] affects project files and/or build settings. area:docs [issue/PR] affects documentation (excluding XML documentation that is part of source code). ignore-for-release [PR] shall not be listed in release notes. and removed area-build labels Oct 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:build [issue/PR] affects project files and/or build settings. area:docs [issue/PR] affects documentation (excluding XML documentation that is part of source code). ignore-for-release [PR] shall not be listed in release notes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant