Release Notes

[tabatkins]

(This thread documents the updates in comments; this original comment always reflects the latest version.)

Version 5.0.6

• Updated widlparser dependency to 1.2, which fixes some bugs surrounding whether dictionary args in IDL blocks need to be optional or not.

[tabatkins]

Version 2.0.0

• Feature: Added darkmode styles!

  This is the reason for the version bump, as if you were adding your own styles to your document, they probably aren't darkmode-aware and will look bad when the readers are in darkmode. If you're just using Bikeshed's own styles, tho, everything will work exactly as before.

• Feature: Added new conditional-inclusion feature, allowing you to remove sections of a spec (typically in boilerplate) based on the document's Status. If you have more things you want to base a conditional inclusion off of, let me know!

  (Currently, the processing order of this happens after all the 'datablocks' (pre with special class that triggers Bikeshed handling) happens, so even if those are inside of a conditional that gets excluded, they'll still get processed. But everything else happens after conditional stuff is removed.)

• Bugfix: The rest of IDL's built-in types are now autolinked.

[tabatkins]

Version 2.1.0

• Feature enhancement: Conditional inclusion can now conditionalize on the presence of a custom boilerplate element (something with boilerplate=foo attribute) or the presence of a custom text macro, so you can include a chunk of related HTML only when the thing it's trying to refer to actually exists!

• Feature: Autolink conjugations (the thing that lets you write [=applying=] when the original definition was just <dfn>apply</dfn> now apply to the first word of a phrase as well as the last. This will usually catch the verb in a multi-word phrase, like "apply the widget", so you can write [=applying the widget=] and have it Just Work. (But all the conjugations apply, so noun-headed terms like "widget controlled by the user" can be autolinked with [=widgets controlled by the user=] now.)

• Feature: Biblio autolinks (like [[FOO]]) can now be switched into "inline" display mode, where rather than displaying as "[FOO]" and linking to the bibliography, they display as the actual document's title and link straight to them. (They still get added to the index.) You can turn it on individually with [[FOO inline]], or set the default for all biblios in the spec with Default Biblio Display (and switch them back to "index" mode with [[FOO index]]).

• Bugfix: Better darkmode styles! Various fixes thruout, including to certain boilerplates.

• Bugfix: bumped the versions for several dependencies to the most recent form, just for general dependency-hygiene reasons

• Bugfix: If you used Editor Term to rename what the spec-metadata section called "Editors", various small side-effects that should specially trigger for the Editor lines... wouldn't. They do now.

[tabatkins]

Version 2.3.0

Whoops, didn't write release notes for the 2.2 versions! Oh well!

• Feature: Global -a flag to force Bikeshed to emit ASCII-only in all its messages.

• Feature: When using WPT Path Prefix with a lot of tests missing, don't spam the full list out, just log a warning that there are a bunch.

• Feature: Biblio autolinks can now take the obsolete keyword to allow an intentionally-obsolete reference (otherwise Bikeshed complains and automatically switches your ref to what obsoleted it).

• Feature: Finally got daily test updates working, so we run with the most modern set of specs rather than ones that are obsolete by months.

• Bugfix: Stop ignoring certain test types from WPT, so any test can be linked.

• Bugfix: Track what data files exist locally manually, rather than relying on the list matching what the remote data last contained.

• Bugfix: Grab the correct set of boilerplates for the specified Status.

• Misc: Lots and lots of fixes to make Bikeshed lint-clean.

[tabatkins]

Version 2.3.1

• A bunch of dependency bumping
• More importantly, Automatic Image Size Detection, care of @frivoal! If your <img> elements don't already have width/height attributes on them, Bikeshed will do its best to auto-detect what the sizes are, and insert them into your markup automatically. This is a small but nice perf improvement for specs, avoiding layout-jiggle as images load in.

Version 2.4.0

• Added the NOTE-ED, NOTE-WD, and NOTE-FPWD statuses, for handling the new somewhat-more-official "Note track" for W3C documents, so you can have boilerplates with appropriate verbiage to indicate it's a Note-track document. (REGISTRY-* statuses will come in a bit, when the updates to W3C Process finish up enough to allow publishing such a document.)
• Minor fixes to boilerplates and styles. Shouldn't be anything you notice, but if you're tracking diffs in your generated output you'll see some chatter.
• Another banger from @frivoal, <wpt> elements have some new features:
  • <wpt hidden> processes the element but omits it from the output (useful for leveled specs that need to include all the tests in their folder so they can benefit from WPT Prefix, but don't actually have a place to put the tests for up/down-level versions)
  • <wpt title> lets you specify a descriptive paragraph for the tests in the block, formatting it just above the test list in the output
  • Multiple adjacent <wpt> elements will now be merged in the output
  • Best of all, rendered <wpt> elements are now <details> elements, and the new WPT Display: closed renders them closed by default (the previous inline value and its new alias open render them open by default, looking approximately the same as they previously did). The default styling for a closed <wpt> is a tiny out-of-the-way "TESTS", suitable for displaying even in live, published specs. Play with it for now, consider adding it to your defaults.include file. I plan to flip this to be the default in a near-future version.

[tabatkins]

Version 2.4.1

• Several small boilerplate tweaks to some groups
• <wpt title> attribute is now parsed as Bikeshed source

[tabatkins]

Version 2.4.2

• A few boilerplate updates, as always
• Properly strip the internal-use attributes from <pre class=include-code> elements from the output document, so they won't cause your document to fail HTML validation.

Version 2.4.3

• Boilerplates again.
• A couple of widlparser dependency updates

[tabatkins]

lol been skipping release notes for a while!

Version 2.4.4

• boilerplates again

Version 2.4.5

• boilerplates
• removed some ancient (and now incorrect) lines from the linking-defaults file

Version 2.4.6

• accidentally did the previous release on Windows and picked up Windows line endings

Version 2.4.7

• fixed the url link-defaults was pulled from during update!
• boilerplates
• bumped a lot of dependencies
• fixed 3d037a4, which caused text to get dropped in some circumstances

Version 3.0.0

• New major version! Nothing exciting, I just pushed a breaking change for security reasons; you now have to explicitly opt-in, from the command line, to allowing Bikeshed to grab data from outside the input file's directory, or running arbitrary code via some extensions features.
• biblio entries and links now use cite, such semantic e4a654b
• boilerplates

Version 3.0.1

• boilerplates
• actually lint the 3.0.0 code that restricted use of files outside the source directory

Version 3.0.2

• boilerplates
• some correctness fiddling to the 3.0.0 code

Version 3.0.3

• ??? I did literally nothing, weird.

Version 3.0.4

• boilerplates (jeez I'm getting tired of this)

Version 3.0.5

• boilerplates

Version 3.0.6

• boilerplates

Version 3.1.0

• NO MORE BOILERPLATES UPDATES. Bikeshed now stores and versions its boilerplates over at https://github.com/tabatkins/bikeshed-boilerplate, and brings in updates via bikeshed update like any other data files.

Version 3.2.0

• fix a lot of lint errors from 3.1.0
• propdef tables now link their "Applies To" header 980486a
• Issues lists (from bikeshed issues-list) can now have intro text c2f0309
• Format links to GH issues better 8bb5020
• Added AOM as a group and megagroup, plus some new statuses for them

Version 3.3.0

Big new WPT features - inline test results!

• <wpt> blocks now contain pass/fail information in the main browsers! f07e1bf
• wpt lines indicate when a test file contains multiple tests, and how many
• If there's a WPT path prefix (or I can infer one), add the corresponding http://wpt.fyi link in the spec-metadata section up top
• also add pass/fail data for all spec's tests combined to the spec-metadata section

And some other random stuff:

• Stop doing the weird "implicitly call .format() on messages" and just use f-strings or explicit .format() everywhere 368df1c
• Update the dockerfile 24054d8
• propdef tables now link their "Canonical Order" header ed3425a
• bikeshed template now outputs a Status that actually works, so you can use its output immediately, as intended.

Version 3.3.1

• adapt to the Process 2021 changes that got sprung on me without announcement

Version 3.3.2

• I'd accidentally been omitting the wpt data files from the distributed version. They'll be as out of data by default as all the other built-in data files, but they should at least exist. Fixed now. bbc3648

Version 3.3.3

• remove some now-unused W3C NOTE statuses 6cf9175
• Only set the LOGO macro if Logo metadata is actually set 31a2f03
• Allow conditional logic to look at non-custom metadata too; combined with previous, you can now add a default logo if a spec doesn't set their own logo. 31a2f03

Version 3.3.4

• CanIUse blocks are now closed by default, like MDN blocks be0e7d0
• Fix update link for boilerplate files a892fb1
• Actually clean up old boilerplate files that no longer exist cace53f

Version 3.4.0

• Add pngwg to W3C groups (I need to move this data out of this repo, too.....) c9308f3
• New "direct" biblio style that still formats the link text as the shortname (to match the biblio entry), but skips the biblio and links straight to the document. 1f16618
• Documented the W3C's spec-prod GH action, which makes it easy to auto-publish with Bikeshed
• Disallow merged Privacy/Security sections, per new W3C rules 893894c
• When you've just got a few headings missing their ID, output them individually so they get line numbers c29faa6
• Document how to set "html metadata" (attributes on html, meta/link/style/script elements) 8eaccd9
• Detect and scream when you're likely hitting the dumb years-old argparser bug about spaces in the values of unknown flags beb1f28
• Strip the common WS prefix from fenced code blocks, same as I do for pre elements 53a8100
• Add a new debug command to output all the metadata passed to the document, from all the possible sources cd66b7b

[tabatkins]

Version 3.4.13.4.2

• Previously, Bikeshed would helpfully not spam you with all the missing tests that matched your WPT Path Prefix if there were more than a handful, since there were legit reasons to have a bunch of untracked tests (tests not for your level, maybe you're in the middle of annotating, etc). Now that we have <wpt hidden> to do a well-targeted silencing when required, that's no longer a problem, so let'er rip. f965859

• If you've only got empty/hidden wpt elements, Bikeshed no longer adds the JS, spec-metadata entries, etc. Style still comes thru so the blocks render, at least. 4d354f1

• The legacy processor Bikeshed replaced handled links to properties and descriptors identically; 'font-family' would gladly link to the property or the @font-face descriptor, depending on what was in the spec. That never worked well in the first place (the Fonts spec would randomly link to each), and while Bikeshed could at least detect the issue and complain about it, it's annoying to deal with when properties are usually what you wanted to link to. It's gotten worse as we've added more descriptors whose names collide with properties, like 'width' or 'aspect-ratio'.

  So, propdesc autolinks without an explicit for value are now always treated as property autolinks; 'width' will always link to the 'width' property, and never ask if you meant the 'width' MQ or CQ descriptor. You can still use the syntax with a for value, like '@media/width', to link to descriptors. This might cause some new link failures, but more likely it'll cause some existing link failures to go away and link correctly. f9584d2

(I accidentally forgot to pull on my release box before I cut the 3.4.1 release, so 3.4.2 actually contains all the stuff.)

[tabatkins]

Version 3.5.0

• Fixed the automatic indent-removal for pre blocks in some cases bd9a15d
• Added the [:http header:] autolink syntax
• Added the "permission" definition type f092c3a
• Trust anchor-block entries, even if the spec you're linking to is marked as obsoleted in SpecRef b1c6bfa
• Allow div around dt/dd, including markdown-generated ones, since that's valid in HTML. Previously it would often kinda work by accident if you contorted your markup in a certain way, but it was real bad. 790e008
• Lots of adventures in beginning add typing information to Bikeshed. Long way to go yet.
• Properly autolink the type signatures in argumentdef blocks. ac0d420
• Added a few W3C groups and statuses

Version 3.5.1

• Added the fedidcg group

Version 3.5.2

• Made section autolinks also trigger a biblio entry, which I believe is the last place that should be able to do so. Also localized the code that tracks this so all the entry points do the exact same thing; this means some of your biblio entries might change casing since they're consistent across all callsites now. There's still some mismatch between what specs I know about via biblio data and what specs I know about from definition data, which I know will cause at least a few instances where "the same" biblio entry shows up twice under slightly different names, but that's a separate issue that won't be fixed until I move Bikeshed's definitions entirely to Reffy. fdd5936

[tabatkins]

Version 3.6

• <div assert> now works, to get the same auto-generated ID as <assert> does, but for block-level. (<assert> turns itself into a <span> in the output.) (Thanks, @dj2!)
• Fixed some new duplication of normative/informative refs caused by the section autolinks fixes from 3.5.2.

Version 3.7

• Can now build multi-file specs directly from an (uncompressed) TAR file! This is worthless locally, but you can use this to send multi-file specs to the API server. (Thanks, @kainino0x!)

[tabatkins]

Been a while since my last batch of release notes!

Version 3.7.1

• WPT tests mentioned multipled times in a spec now properly only count once for the test counts (Only count each WPT test once for the summary view #2304)
• WPT summaries use the proper Stable channel browser logos (WPT: Use Stable Channel Browser Logos #2296)
• Started some serious mypy-ification

Version 3.7.2

• Fix a bug I caused while mypy-ing.
• More mypy-ification.

Version 3.7.3

• Fix a minor bug from an argument being removed in py 3.9.
• More mypy-ification. (Seeing a trend? This continues until October.)

Version 3.7.4

• Just mypy stuff. Unsure why I cut this version, honestly?

Version 3.7.5

• Fix the merging of adjacent MDN blocks.
• Fix caniuse and MDN darkmode styles.
• Made the markdown em/strong replacers work better. They're still not right, but they're now less wrong.
• Complain About: broken-links yes now has a timeout so it can't hang indefinitely.
• Fixed a cache accidentally getting shared across documents, continually growing when you generate a bunch of specs (like bikeshed test does...)
• Fixed how heading data is recognized from the data source, to better handle how ReSpec formats its markup.
• FINISHED MYPY-IFICATION

Version 3.7.6

• Properly add some new non-py files introduced by 3.7.5 to the release data.

Version 3.7.7

• Fixed a spot where if you force-generate (so die() doesn't stop the program) it would end up with inconsistent state and cause a Python error anyway.

Version 3.8.0

• Added simple def tables, formatted like propdef/etc but arbitrary keys
• Added bikeshed update --force-manifest that forces it to do a manifest update even if the remote's date indicates your local data should be more recent.

Version 3.8.1

• Fix anchor recognition, which was broken in 3.7.5 by the heading fix.

Version 3.8.2

• Added a missing from __future__ import annotations that was causing a crash in older Python versions.
• Only warn about missing WPT tests under your specified prefix once, rather than twice.

Version 3.9.0

• Properly flag if your anchor-block refs have a local URL (which breaks other stuff anyway).
• Fix a long-standing issue where section autolinks could generate a similar or duplicate biblio entry to what was already generated by definition autolinks.
• Obsolete biblio links are now LINKERROR, not FATAL.
• Moved the self-links from notes/issues/examples to avoid being cut off by their 'overflow' value.
• HTTP Header autolinks now use the correct typography per Infra.
• Added Complain About: mixed-indents yes to catch when you mix tabs and spaces in bad ways.

[tabatkins]

New big batch of release notes:

Version 3.10.0

• Added explicit support for "Logical Property Group" in propdef blocks

Version 3.10.1

• Biblio links now have the reference's title as their title (unless they're inline, since those already have the title as their text)
• Better parsing for Markdown URL syntax. (Think it's still not perfect, but substantially improved wrt parsing the url portion.)
• Fixed the bikeshed echidna --just-tar option to actually echo the TAR file, rather than whatever broken nonsense it had ended up doing.
• Fixed a bug with negative ranges in the CSS <length [-100px, 100px]> syntax, and just switched to using hyphen-minus rather than the fancy math minus.

Version 3.11.0

• Switched Bikeshed's ref database to using the W3C's WebRef service, rather than plinss's Shepherd service. Lots of commits related to this.
• Note markers (the "Note:" bit) now have class=marker, as the docs said they should.

Version 3.11.1

• Reworked the "unused var" error-checking so I could output line numbers, to help find the error.

Version 3.11.2 & 3.11.3

• Bikeshed moved official ownership! Now a project under the Specification Editors CG in the W3C, at https://github.com/speced/bikeshed.

Version 3.11.4

• After some poking at WebRef to get the data complete, Bikeshed no longer relies on Shepherd at all.
• Put a really cute little progress bar on both the manual update info, and test running.

Version 3.11.5

• Fixed the "mixed indentation" lint to properly allow tabs followed by spaces. (Spoilers: it's still broken at this point.)
• Added the first part of my new bespoke HTML parser.
• Fiddled with the dfn panel generation/positioning for better a11y.

Version 3.11.6

• Fixed the "mixed indentation" lint correctly.
• Try to infer the indent from source analysis, rather than just looking at the first indented line.

Version 3.11.7

• Fiddle with ID generation for links that dfn panels need to link to, to make them more likely to be unique.

Version 3.11.8

• Fix how I package bikeshed for release, so I'll stop forgetting to include new .css and .js files when I add them.

Version 3.11.9

• Fixed a filepath.

Version 3.11.10

• Removed a good chunk of the ARIA stuff I tried to add, since it technically violated the ARIA spec (even tho I think it was right). Grumble, grumble.

Version 3.11.11

• Unify a lot of the CanIUse/MDN panel code, particularly positioning. Switch them from doing some funky abspos-with-static-position stuff to being positioned purely with JS, since they can trivially overlap otherwise.
• Specs marked as "fork" in WebRef are no longer included in the db.
• A bunch of fiddling with the update code to untangle the old mess of transforms needed for mixing the Shepherd and WebRef sources. Since it's all WebRef now I can make it much simpler.

Version 3.11.12

• Accidental rerelease, lol

Version 3.11.13

• Include .bsfont files in the build too. Surprised this is the first time someone's run into this issue!

Version 3.11.14

• Preserve the start-tag's attributes when handling all the various datablocks (propdef, railroad, include, etc).
• Move the semver file into the bikeshed folder so it's actually installed by pip. Turns out the top-level files aren't!

Version 3.11.15

• Nothing, just didn't notice the semver got bumped again while I was fiddling with the release script.

Version 3.11.16

• Since 3.11.14 started using the new bespoke HTML parser, it can accidentally surface some HTML mistakes that were previously silently accepted. The error messages weren't showing the right line tho - now fixed.