-
Notifications
You must be signed in to change notification settings - Fork 72
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
Report improvements #68
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Revert "wip: start refactor to esm, required for remark-toc support" This reverts commit b9491a6. * esm works -- but needed to patch micro-ftch * no patch needed
mds1
commented
Jun 17, 2022
@@ -0,0 +1,213 @@ | |||
import fs, { promises as fsp } from 'fs' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file was renamed from markdown.ts
Successful test CI run in https://github.com/Uniswap/governance-seatbelt/actions/runs/2569653666, so merging this |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #33, replaces #67
Why we are closing #67 in favor of this approach:
Actions now result in 3 artifacts per report: A markdown file, a PDF, and an HTML file. The collapsible details blocks supported by markdown don't work well with the other output formats, so they have been removed and replaced with a table of contents for easier navigation.
Sample proposal reports can be found in the artifacts of this workflow run: https://github.com/Uniswap/governance-seatbelt/actions/runs/2515723372
The HTML reports have two issues:
Table of contents links do not work. It seems the emojis cause issues here, tracking this in reports: fix links in HTML reports #70Fixed by Get toc links working in all 3 report formats #72