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

publish site docs #115

Open
wants to merge 40 commits into
base: main
Choose a base branch
from
Open

publish site docs #115

wants to merge 40 commits into from

Conversation

ericbuckley
Copy link
Collaborator

@ericbuckley ericbuckley commented Nov 1, 2024

Description

Updating the release.yml CI workflow to build and publish site docs to GH pages.

Related Issues

closes #112

Additional Notes

  • Reworking recordlinker.utils into a package, to make room for a new module, recordlinker.utils.openapi_schema

<--------------------- REMOVE THE LINES BELOW BEFORE MERGING --------------------->

Checklist

Please review and complete the following checklist before submitting your pull request:

  • I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
  • I have reviewed my changes to ensure they are clear, concise, and well-documented.
  • I have updated the documentation, if applicable.
  • I have added or updated test cases to cover my changes, if applicable.
  • I have minimized the number of reviewers to include only those essential for the review.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

  • The code follows best practices and conventions.
  • The changes implement the desired functionality or fix the reported issue.
  • The tests cover the new changes and pass successfully.
  • Any potential edge cases or error scenarios have been considered.

@ericbuckley ericbuckley self-assigned this Nov 1, 2024
Copy link

codecov bot commented Nov 1, 2024

Codecov Report

Attention: Patch coverage is 87.17949% with 5 lines in your changes missing coverage. Please review.

Project coverage is 95.13%. Comparing base (f0944e3) to head (5411408).

Files with missing lines Patch % Lines
src/recordlinker/utils/__init__.py 85.71% 2 Missing ⚠️
src/recordlinker/linking/link.py 0.00% 1 Missing ⚠️
src/recordlinker/routes/link_router.py 0.00% 1 Missing ⚠️
src/recordlinker/utils/openapi_schema.py 88.88% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #115      +/-   ##
==========================================
- Coverage   95.17%   95.13%   -0.04%     
==========================================
  Files          26       29       +3     
  Lines        1284     1294      +10     
==========================================
+ Hits         1222     1231       +9     
- Misses         62       63       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ericbuckley ericbuckley marked this pull request as ready for review November 4, 2024 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

publish API docs into GH pages
1 participant