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

chore(build): fix newline in inline docs causing website build failures #1050

Merged
merged 1 commit into from
Nov 1, 2022

Conversation

mirceanis
Copy link
Member

What issue is this PR fixing

A newline in the inline documentation is causing the automatic deployment of the website to fail.
https://github.com/uport-project/veramo-website/actions/runs/3364937894/jobs/5579863804

What is being changed

This PR fixes the errant newline and also adds a patch to the documentation processing script to prevent this from repeating.

Quality

Check all that apply:

  • I want these changes to be integrated
  • I successfully ran yarn, yarn build, yarn test, yarn test:browser locally.
  • I allow my PR to be updated by the reviewers (to speed up the review process).
  • I added unit tests.
  • I added integration tests.
  • I did not add automated tests because this is only a docs and tooling change.

@codecov
Copy link

codecov bot commented Nov 1, 2022

Codecov Report

Merging #1050 (746154b) into main (022016d) will increase coverage by 0.50%.
The diff coverage is 88.19%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1050      +/-   ##
==========================================
+ Coverage   80.15%   80.66%   +0.50%     
==========================================
  Files         118      124       +6     
  Lines        4173     4525     +352     
  Branches      897      977      +80     
==========================================
+ Hits         3345     3650     +305     
- Misses        825      871      +46     
- Partials        3        4       +1     

@mirceanis mirceanis merged commit fe10c70 into main Nov 1, 2022
@mirceanis mirceanis deleted the newline-docs-failure branch November 1, 2022 15:18
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.

2 participants