privacycg / nav-tracking-mitigations

Navigation-based Tracking Mitigations
https://privacycg.github.io/nav-tracking-mitigations/
35 stars 16 forks source link

Disambiguate `remote end steps` dfn link #84

Closed svendlarsen closed 1 month ago

svendlarsen commented 1 month ago

Running bikeshed on main yields the following output:

LINE ~837: Multiple possible 'remote end steps' dfn refs.
Arbitrarily chose https://patcg-individual-drafts.github.io/private-aggregation-api/#remote-end-steps
To auto-select one of the following refs, insert one of these lines into a <pre class=link-defaults> block:
spec:private-aggregation-api; type:dfn; text:remote end steps
spec:webdriver2; type:dfn; text:remote end steps
[=remote end steps=]
 ✔  Successfully generated, with 1 linking errors

i.e., bikeshed selects the wrong dfn link for remote end steps.

With this change, running bikeshed produces no warnings and correctly links to the webdriver spec's dfn for remote end steps.


Preview | Diff

svendlarsen commented 1 month ago

It looks like CI possibly needs to be updated? It's failing to install bikeshed:

$ pip3 install bikeshed --quiet
    error: externally-managed-environment
wanderview commented 1 month ago

@jyasskin can you help with the CI problem? Or point us to someone who can?

jyasskin commented 1 month ago

Probably triggered by https://github.com/actions/runner-images/issues/10636. I've filed https://github.com/w3c/spec-prod/issues/189, and I'll send a PR, but I won't have time to test it.

jyasskin commented 1 month ago

You can work around the problem by changing https://github.com/privacycg/nav-tracking-mitigations/blob/1fa286a38ab742b0d8eb0963bcffb3f1cf9ba46a/.github/workflows/deploy.yml#L8 to ubuntu-22.04.

wanderview commented 1 month ago

@svendlarsen can you rebase this on the tool chain change to see if it passes CI now?

svendlarsen commented 1 month ago

Yep, success!