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

Improving documentation CI workflows #922

Merged
merged 27 commits into from
Jun 10, 2022
Merged

Improving documentation CI workflows #922

merged 27 commits into from
Jun 10, 2022

Conversation

italobb
Copy link
Contributor

@italobb italobb commented Jun 8, 2022

  • Moved the scripts for docs generation from veramo-website to veramo
  • The veramo-website workflow will run when code is pushed to main
  • Fixing small issues in the docs generator

@italobb italobb requested a review from mirceanis June 8, 2022 15:48
@mirceanis mirceanis changed the base branch from next to main June 8, 2022 16:05
Copy link
Member

@mirceanis mirceanis left a comment

Choose a reason for hiding this comment

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

Generally good, but I have some doubts about the token permissions when dispatching to the other repo.

I think that using the repository_dispatch event may be safer

scripts/docs-extract.ts Outdated Show resolved Hide resolved
.github/workflows/veramo-website.yml Outdated Show resolved Hide resolved
.github/workflows/veramo-website.yml Outdated Show resolved Hide resolved
.github/workflows/build-and-test-on-pr.yml Outdated Show resolved Hide resolved
.github/workflows/build-and-test-on-pr.yml Outdated Show resolved Hide resolved
.github/workflows/veramo-website.yml Show resolved Hide resolved
@italobb italobb requested a review from mirceanis June 10, 2022 17:13
@codecov
Copy link

codecov bot commented Jun 10, 2022

Codecov Report

Merging #922 (7ad1b4c) into main (6884b28) will decrease coverage by 0.88%.
The diff coverage is 16.66%.

❗ Current head 7ad1b4c differs from pull request most recent head ad0a917. Consider uploading reports for the commit ad0a917 to get more accurate results

@@            Coverage Diff             @@
##             main     #922      +/-   ##
==========================================
- Coverage   81.78%   80.90%   -0.89%     
==========================================
  Files          85       85              
  Lines        2652     2697      +45     
  Branches      507      557      +50     
==========================================
+ Hits         2169     2182      +13     
- Misses        481      515      +34     
+ Partials        2        0       -2     

Copy link
Member

@mirceanis mirceanis left a comment

Choose a reason for hiding this comment

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

Only one last thing to do, please check the URL for triggering the repository dispatch.
I added a suggestion with what I believe to be the right URL.

Everything else looks great!

.github/workflows/veramo-website.yml Outdated Show resolved Hide resolved
Co-authored-by: Mircea Nistor <mirceanis@gmail.com>
@italobb italobb requested a review from mirceanis June 10, 2022 18:14
Copy link
Member

@mirceanis mirceanis left a comment

Choose a reason for hiding this comment

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

Looks great

@mirceanis mirceanis merged commit 0579764 into main Jun 10, 2022
@mirceanis mirceanis deleted the italo/fix-docs branch June 10, 2022 18:25
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