WHATWG Standard repository templates and infrastructure
License: Creative Commons Zero v1.0 Universal
This repository enables repositories of WHATWG standards to be organized centrally to a certain extent. This is useful for the support files (the files with the .template and .template-part extensions), which are often nearly identical and prone to errors.
factory.py takes care of updating existing WHATWG standard repositories. It assumes they are in parallel directories using their "shortname" as directory name. factory.json supplies data for a exceptional cases.
Maybe add some logic to exclude it.
The local and remote targets of the Makefile template define the SNAPSHOT-LINK text macro, which used to define the "snapshot as of this commit" link in the spec metadata. speced/bikeshed#1635, however, removed any usage of that macro, instead using a new COMMIT-SHA macro for the LS status, which those Makefile targets don't define.
This would be solved by removing the SNAPSHOT-LINK definition and adding one for COMMIT-SHA defining it to be the empty string, for example. However, this would create a link pointing to ./commit-snapshots//, which isn't ideal.
A bunch of standards have https://github.com/whatwg/url/blob/main/CONTRIBUTING.md which seems like something we should handle here instead.
https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch would allow us to manually run a workflow in the event we need it.
We kinda need it now and it seems impossible without creating commits.
whatwg/dom#877 includes lots of other changes, where I had a .spec.whatwg.org directory in my dom/ checkout, after a bug fixed in whatwg/whatwg.org#325.
The script should either fail if there are any local changes, or just make fresh copies of all repos. As it is, it assumes you have all repos checkout out alongside spec-factory, but how to keep those up-to-date is an exercise for the reader. Here's the script I've arrived at over time:
#!/bin/bash -e
curl --silent --fail "https://api.github.com/orgs/whatwg/repos?per_page=100" | \
#grep -E '^ "name":' | cut -d \" -f4 | \
#grep -vE '^(domparsing|javascript|old-google-code-html5|resources.whatwg.org)$' | \
jq -r '.[] | select(.archived == false) | .name' | sort | \
while read name; do
if [[ -d "$name" ]]; then
echo "Updating $name"
(
cd "$name"
git fetch --prune
git rebase-update --no-fetch --keep-going
)
else
echo "Cloning $name"
git clone "[email protected]:whatwg/$name.git"
fi
doneIt would be good if it just works instead.
I got this when it tried to create the 10th pull request. It also ended up failing for subsequent ones. I guess the workaround is to run things again a minute or so later, but this is somewhat annoying.
Currently, we use an ad-hoc replacement mechanism for constructs of the form @@variable@@. If we use something like Jinja2, we would get a lot more features for free, such as if conditionals, which would be useful for whatwg/url#525.
This requires a bit more discussion I think about what should go in the README and what should go in a local CONTRIBUTING.
Examples that differ:
Many other things are extremely consistent though and ought to be the same.
The HTML spec makes use of the file-issue.js script, which provides a "File an issue about the selected text" link in the bottom right corner that when clicked previously opened the issue form prefilled with the selected text:
return originalFilingURL + '?title=' + encodeURIComponent(bugData.title) + '&body=' +
encodeURIComponent(bugData.body);The new issue templates broke this since the body URL param no longer works. Fixing this will require four steps:
data-file-issue-url= in the HTML source file to include ?template=0-new-issue.yml.file-issue.js to preserve existing URL parameters.id: issue-body below type: textarea in 0-new-issue.yml. (I tested it and unfortunately GitHub ignores the id if it is set to body.)data-body-url-param option in file-issue.js and adding data-body-url-param="issue-body" to the HTML source file.While I took the time to figure this out, I'm not interesting in implementing these steps myself ... I'm busy polishing my HTML parser.
With the new issue template every issue created starts with:
### What is the issue with the HTML Standard?
which is rather redundant. Can we somehow disable this?
Currently there are the following issues. Since we don't run this often it's unclear whether they need to be resolved.
compatibility.bs while its shortname is compat./UnicodeData.txt in .gitignore..gitignore. Probably because building is done elsewhere..pr-preview.json, but also seems to have some errors there (e.g., does not overwrite h1).Overall it works pretty well though (for 10 out of 15, and for the remaining 5 it still helps identifying issues) and ends up adding PULL_REQUEST_TEMPLATE.md to a bunch of places as well as making minor ordering changes to .gitignore.
It's a bit cleaner.
That seems to follow what we do in practice.
I've seen this with the GitHub Actions updates, and now for #18.
This is the full log before it got stuck:
$ python3 factory.py
Enumerating objects: 5, done.
Counting objects: 100% (5/5), done.
Delta compression using up to 16 threads
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 368 bytes | 368.00 KiB/s, done.
Total 3 (delta 2), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (2/2), completed with 2 local objects.
remote:
remote: Create a pull request for 'meta-template/cfba3326-b9e4-11ea-afa6-acde48001122' on GitHub by visiting:
remote: https://github.com/whatwg/compat/pull/new/meta-template/cfba3326-b9e4-11ea-afa6-acde48001122
remote:
To github.com:whatwg/compat.git
* [new branch] HEAD -> meta-template/cfba3326-b9e4-11ea-afa6-acde48001122
Branch 'meta-template/cfba3326-b9e4-11ea-afa6-acde48001122' set up to track remote branch 'meta-template/cfba3326-b9e4-11ea-afa6-acde48001122' from 'origin'.
https://github.com/whatwg/compat/pull/129
A new release of gh is available: 0.10.0 → v0.10.1
https://github.com/cli/cli/releases/tag/v0.10.1
Enumerating objects: 5, done.
Counting objects: 100% (5/5), done.
Delta compression using up to 16 threads
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 368 bytes | 368.00 KiB/s, done.
Total 3 (delta 2), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (2/2), completed with 2 local objects.
remote:
remote: Create a pull request for 'meta-template/d50e4d8a-b9e4-11ea-afa6-acde48001122' on GitHub by visiting:
remote: https://github.com/whatwg/console/pull/new/meta-template/d50e4d8a-b9e4-11ea-afa6-acde48001122
remote:
To github.com:whatwg/console.git
* [new branch] HEAD -> meta-template/d50e4d8a-b9e4-11ea-afa6-acde48001122
Branch 'meta-template/d50e4d8a-b9e4-11ea-afa6-acde48001122' set up to track remote branch 'meta-template/d50e4d8a-b9e4-11ea-afa6-acde48001122' from 'origin'.
https://github.com/whatwg/console/pull/184
A new release of gh is available: 0.10.0 → v0.10.1
https://github.com/cli/cli/releases/tag/v0.10.1
Enumerating objects: 15, done.
Counting objects: 100% (15/15), done.
Delta compression using up to 16 threads
Compressing objects: 100% (10/10), done.
Writing objects: 100% (13/13), 276.79 KiB | 2.64 MiB/s, done.
Total 13 (delta 4), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (4/4), completed with 2 local objects.
remote:
remote: Create a pull request for 'meta-template/dcf254c4-b9e4-11ea-afa6-acde48001122' on GitHub by visiting:
remote: https://github.com/whatwg/dom/pull/new/meta-template/dcf254c4-b9e4-11ea-afa6-acde48001122
remote:
To github.com:whatwg/dom.git
* [new branch] HEAD -> meta-template/dcf254c4-b9e4-11ea-afa6-acde48001122
Branch 'meta-template/dcf254c4-b9e4-11ea-afa6-acde48001122' set up to track remote branch 'meta-template/dcf254c4-b9e4-11ea-afa6-acde48001122' from 'origin'.
https://github.com/whatwg/dom/pull/877
A new release of gh is available: 0.10.0 → v0.10.1
https://github.com/cli/cli/releases/tag/v0.10.1
Enumerating objects: 5, done.
Counting objects: 100% (5/5), done.
Delta compression using up to 16 threads
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 369 bytes | 369.00 KiB/s, done.
Total 3 (delta 2), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (2/2), completed with 2 local objects.
remote:
remote: Create a pull request for 'meta-template/e246f10a-b9e4-11ea-afa6-acde48001122' on GitHub by visiting:
remote: https://github.com/whatwg/encoding/pull/new/meta-template/e246f10a-b9e4-11ea-afa6-acde48001122
remote:
To github.com:whatwg/encoding.git
* [new branch] HEAD -> meta-template/e246f10a-b9e4-11ea-afa6-acde48001122
Branch 'meta-template/e246f10a-b9e4-11ea-afa6-acde48001122' set up to track remote branch 'meta-template/e246f10a-b9e4-11ea-afa6-acde48001122' from 'origin'.
https://github.com/whatwg/encoding/pull/222
A new release of gh is available: 0.10.0 → v0.10.1
https://github.com/cli/cli/releases/tag/v0.10.1
Enumerating objects: 5, done.
Counting objects: 100% (5/5), done.
Delta compression using up to 16 threads
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 366 bytes | 366.00 KiB/s, done.
Total 3 (delta 2), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (2/2), completed with 2 local objects.
remote:
remote: Create a pull request for 'meta-template/e79833e4-b9e4-11ea-afa6-acde48001122' on GitHub by visiting:
remote: https://github.com/whatwg/fetch/pull/new/meta-template/e79833e4-b9e4-11ea-afa6-acde48001122
remote:
To github.com:whatwg/fetch.git
* [new branch] HEAD -> meta-template/e79833e4-b9e4-11ea-afa6-acde48001122
Branch 'meta-template/e79833e4-b9e4-11ea-afa6-acde48001122' set up to track remote branch 'meta-template/e79833e4-b9e4-11ea-afa6-acde48001122' from 'origin'.
https://github.com/whatwg/fetch/pull/1046
A new release of gh is available: 0.10.0 → v0.10.1
https://github.com/cli/cli/releases/tag/v0.10.1
Username for 'https://github.com':
I don't understand why fetch was different. My only remote is [email protected]:whatwg/fetch.git. I also don't have a personal fork of the repo, which I first suspected might make it different.
@annevk have you seen this?
This was an idea initially, but if we create a repository containing a .bs resource and add the new standard to db.json this would take care of that automatically.
I suppose we could make it take care of the .bs resource.
https://github.com/whatwg/spec-factory/blob/main/PULL_REQUEST_TEMPLATE.md.template should be updated with a new checklist item like:
- [ ] [MDN Issue](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md#handling-pull-requests) is filed (if applicable): …Then we need to update https://github.com/whatwg/meta/blob/main/MAINTAINERS.md#handling-pull-requests to give the right instructions for documentation.
@sideshowbarker maybe you could work on the whatwg/meta changes first?
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.