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

Fix local bikeshed build errors #94

Merged
merged 2 commits into from
Feb 24, 2025
Merged

Conversation

MrPickles
Copy link
Contributor

The makefile targets don't work due to minor errors. This PR fixes those errors such that building the spec locally works from the makefile. These are the specific changes:

  • Change out mismatched html tags.
  • Add a table of contents to README.md so doctoc will not modify the file at HEAD.
  • Remove usage of the build directory. (The diagram in the spec won't render properly otherwise. Also outputting index.html in the root is consistent with that the GitHub action does.)
  • Allow warnings with the remote build target. Remote bikeshed does not support taking in images, so it will always have a warning.

In the future, I propose removing doctoc and the remote build target altogether. The table of contents is somewhat nonexistent, so doctoc is an unnecessary dependency. The remote build already has degraded service, so using a local version of bikeshed make more sense. (However, for this PR, I'd prefer to only fix what's broken.)

README.md Outdated
@@ -1,5 +1,13 @@
# Navigation-based Tracking Mitigations

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of Contents
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we exempt this file from doctoc? the TOC doesn't add much here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

doctoc only manages the readme file. It otherwise does nothing in this repo. I reverted the readme back to its original state and removed the doctoc-related target instead.

@MrPickles
Copy link
Contributor Author

@jyasskin do you mind taking a look at this pull request? I believe you're a maintainer of this repo.

@jyasskin jyasskin merged commit 579316d into privacycg:main Feb 24, 2025
1 check passed
github-actions bot added a commit that referenced this pull request Feb 24, 2025
SHA: 579316d
Reason: push, by jyasskin

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@MrPickles MrPickles deleted the build-errors branch February 24, 2025 16:58
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.

3 participants