Repository navigation
v0.15.0
·
23 commits
to main
since this release
Immutable
release. Only release title and notes can be modified.
Upgrade steps:
- Breaking: one
extrasmultiselect replaces the optional CI, profiling, docs-site and library-test questions. Updates from v0.14.0 preserve the old selections, including disabled features. Scripts must pass the fullextraslist instead ofcodecov,codspeed,profiling,cold_install,python_windows,docs_siteortest_extras. See optional features. - Breaking: a
levelquestion (minimal,standardorcommunity) replacesopenssf_badge. An update carries the old answer over:nonebecomesminimal,passingbecomesstandardandsilverbecomescommunity, so a project keeps the documents it had. Atstandard, a new render's README also gets a## Usagesection;README.mdis yours after the first render, so an update leaves it alone. Scripts that pass--data openssf_badge=...need--data level=...instead. - The Python
kindanswer is nowpython_kind, which matchests_kind,rust_kindandgo_kind. An update carries the old answer over and rewrites the answers file. Scripts should pass--data python_kind=.... - At
standard, the render also adds.github/first-release.mdwith the OpenSSF badge step. The Levels page replaces "How much documentation". cold_installis on by default for new projects at thestandardandcommunitylevels, since thecold-installrequirement starts atstandard. An existing project keeps its stored answer; add the workflow withcopier update --ask extras.
Fixed
- A new plain site marks invalid JSON input for screen readers and clears that state when the input is valid. Existing sites keep their own script and stylesheet.
- Links to the old usage guide keep their section anchors after the guide splits into setup, hosting, updates and levels pages.
- Docs sites use Zensical 0.0.74, which escapes quotes and markup in site and page descriptions before writing the HTML meta tag.
- On a narrow screen, Tab no longer reaches the links of an open section in the closed navigation drawer of a docs site.
- A docs site with breadcrumbs labels them "Breadcrumb", so screen readers no longer hear two landmarks called "Navigation".
- Docs-site code blocks drop the empty line-number links screen readers announced without a name (
anchor_linenums = falseinzensical.toml; add it to an existing one as Documentation site shows), and a table wider than the page becomes a focusable region, so it scrolls from the keyboard. - Quick-start commands and preset examples select the intended Python project type with released templates.
- Docs sites that enable code-copy buttons keep their actions from adding duplicate navigation landmarks.
- Docs sites keep mobile navigation reachable by keyboard and selected links readable. Code names in tables no longer break mid-word, and a wide table shows a shadow on the side it scrolls to. New sites use system fonts and a plain repository link without remote statistics; existing sites can adopt the theme settings after updating.
- Closing a Copier update PR unmerged skips that tag on later weekly runs; a newer tag can still open a PR. A fork's pull request from a branch with the same name no longer counts as declining a tag, and the workflow never edits or closes it. Only the issue the workflow opened itself stops the weekly reminder for a tag.
- Worker previews skip Copier update branches, including updates opened by a user account. A bot's push to a pull request a person opened does not start a preview either. Web app deploys keep hidden build files such as
.well-known/security.txt. - Workers explicitly disable observability. With a custom domain, production adds
noindexonly to its duplicate workers.dev origin. - Generated hooks check shell scripts, and Dependabot projects explain how template updates refresh their prek pin.
- The CodSpeed, property and mutation Python jobs, the docs build, and the
cold-install,copier-update,fairandpr-titleworkflows check what uv installs against OSV's malware advisories, as the test job does. tests/test_benchmarks.pybelongs to the project once written. An update or a render into an existing repo keeps the project's own benchmarks, also when it turnscodspeedon. A deleted one comes back, since the benchmarks workflow runs it.
Added
- A licensed Astro site checks production dependency licenses during
just siteand its CI build, using the same checker and allow-list as TypeScript projects. Astro itself is a development dependency because it builds the static files; the site’s security audits include development dependencies. - An Astro site's
site/pnpm-lock.yamlgets its ownpnpm auditjob in the weeklyadvisories.yml, also in a repo whose stacks have no audit of their own. The build job insite.ymlruns the same audit on every push and pull request. just site-serveserves the site locally: Astro's dev server at the address that includes the Pages base, or a plain site over HTTP, since a browser refuses its modules from a file. It fails when port 4321 is taken instead of moving to another port.- Web-service tests exercise an unavailable OTLP HTTP collector, check that requests still succeed and bound shutdown after SIGTERM.
- Levels: the requirements a public repo meets at each level, by the traits that make a requirement apply, with the standard each comes from and the date it starts to count.
levels.tomlholds them, versioned with the template's releases. - A license check in each stack's CI job and check recipe, for a project with a license: licensecheck for Python,
pnpm run licenses(scripts/checkLicenses.mjs) for TypeScript,cargo deny listbesidecargo deny checkfor Rust and go-licenses for Go. Each lists the licenses of the dependencies that ship, not dev tooling, and fails on one the project's license cannot take. TypeScript, Rust and Go share one allow-list that follows thelicenseanswer: permissive licenses (BlueOak-1.0.0, BSL-1.0, CDLA-Permissive-2.0, PSF-2.0, Python-2.0 and Unlicense among them) and MPL-2.0 for every project, the GPL family for a GPL or AGPL one. Python uses licensecheck's own compatibility table instead, which lets LGPL into a permissive project, refuses Zlib and Unicode-3.0 as unknown, and reads anAGPL-3.0-*dependency as the GPL, so a GPL project's check lets it in.deny.tomlnow takes the shared list too, plusApache-2.0 WITH LLVM-exception. If you edited that list,copier updatemay leave a conflict there to resolve. scripts/check_level.pychecks a project's files againstlevels.tomland prints each requirement's status as JSON, with a schema (Checking a repo).- Four requirements in Levels:
ci-testsanddependency-licensesatstandard,release-buildandarchitecture-reviewatcommunity. - The roadmap skeleton at level
communityasks for each planned theme to link the open issue that tracks it. - A web app, a site or a docs site gets
docs/og-card.html, a social card poster built from the project name, description and address,just og-cardto render it toog.png, andog:image, size, alt andtwitter:cardtags in the page head. Runjust og-cardand commit the PNG, or the tags point at a missing file.just og-cardalso rewrites the?v=<hash of the PNG>on theog:imageURL in the page head, so link previews that cache by image URL pick up a redrawn card; commit the page with the PNG. A docs site renders the same image todocs/assets/og.png, anddocs-overrides/main.htmlwritesog:title(the site name on the home page),og:description,og:url,og:image, size, alt andtwitter:cardon every page fromsite_url,site_descriptionandog_imageinzensical.toml; it does nothing withoutog_image. The card source belongs to the project once written: an update adds it when it is missing and leaves an edited one alone. An update does not touch a web app'sindex.htmlor a site's page: add the tags by hand (Social card). A docs site getsdocs-overrides/main.html; addcustom_dir,extra_css,extra_javascriptandog_imageto itszensical.tomlas Documentation site shows.
Changed
- The release workflows' tag check is one call,
verify-tag.sh --fetch, which fetches the tag object and the default branch itself. just repo-aboutalso sets the homepage of a project whose site or documentation site is on GitHub Pages, to its github.io address.- When
just repo-settingsstops because the plan has no rulesets, a Dependabot project also hears that the update App's key would be readable from any branch, with the link to set it up safely. - The usage guide is split by job into setup, hosting, updates and levels pages. Links in a new render's README, justfile, CONTRIBUTING and workflows point at them; the old
docs/usage.mdanchors still lead there.