Skip to content

docs: Replace the dead Travis and AppVeyor badges with the one that runs - #61

Open
krlmlr wants to merge 3 commits into
claude/pkgdown-harmonizationfrom
claude/drop-dead-ci-badges
Open

docs: Replace the dead Travis and AppVeyor badges with the one that runs#61
krlmlr wants to merge 3 commits into
claude/pkgdown-harmonizationfrom
claude/drop-dead-ci-badges

Conversation

@krlmlr

@krlmlr krlmlr commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

The README carries a Linux build badge from travis-ci.org and a Windows one from ci.appveyor.com. NEWS.md for 1.0.1.9002 records "Turn off Travis and AppVeyor (#10)", so neither has reported anything for many releases.

The checks that actually run live in .github/workflows/R-CMD-check.yaml, whose name: is rcc — the badge the rest of this fleet carries. The block also gains the <!-- badges: start --> / <!-- badges: end --> markers that usethis uses to find it.

On the base branch. This targets claude/pkgdown-harmonization (#56) rather than main, and not for stacking convenience: main declares output: downlit::readme_document, and downlit exports no such object, so README.md cannot be regenerated on main at all — the render aborts with 'readme_document' is not an exported object from 'namespace:downlit'. That is worth knowing independently of this change; #56 is what fixes it. Rendering works on that branch, so the README.md and index.md here are a real render rather than a hand edit, and two consecutive renders are byte-identical.

This is not one of the documentation chain's four links — it is an independent fix that happens to need a working render.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m


Generated by Claude Code

krlmlr and others added 3 commits September 13, 2026 09:01
Part of harmonizing how `README.md` and the pkgdown front page are
produced across the fleet.

The output format becomes `cynkratemplate::readme_document`, which is a
`github_document` that also writes the pkgdown front page from the same
render. It carries `-smart` and `--wrap=preserve`, matching duckdb-r,
which has used them longest: together they keep the pandoc pass close to
an identity transform, so no smart quotes and no reflowing to 72
columns. That keeps the rendered file close to its source and makes
future diffs sentence-level rather than whole-paragraph.

Stating the format by name rather than repeating its settings means the
settings live in one place instead of thirty.

Rendering is unchanged in how it is invoked: `rmarkdown::render()`,
`devtools::build_readme()` and the Knit button all work as before, and
all now produce both files. The only new requirement is that
cynkratemplate be installed.

No prose changes.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
Output of `cynkratemplate::render_readme()`, with no hand edits.

`README.md` changes are the pandoc settings from the previous commit
taking effect: `--wrap=preserve` stops badge lines and sentences being
broken at 72 columns, and `-smart` leaves quotes and dashes as written.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
`NEWS.md` for 1.0.1.9002 records "Turn off Travis and AppVeyor (#10)",
so both badges have reported nothing for many releases.
The checks that actually run live in `.github/workflows/R-CMD-check.yaml`, whose `name:` is `rcc`,
and that is the badge the rest of this fleet carries.

The block also gains the `<!-- badges: start -->` / `<!-- badges: end -->` markers,
which `usethis` uses to find it.

Based on the pkgdown harmonization branch rather than `main` on purpose:
`main` declares `output: downlit::readme_document`,
and `downlit` exports no such object,
so `README.md` cannot be regenerated there at all.
Rendering works on this branch, so the committed output is a real render rather than a hand edit --
two consecutive renders are byte-identical.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
@krlmlr
krlmlr force-pushed the claude/drop-dead-ci-badges branch from 1fcc6af to 0dd5486 Compare September 13, 2026 20:33
@krlmlr
krlmlr force-pushed the claude/pkgdown-harmonization branch 2 times, most recently from 7f99c1e to 41314a6 Compare September 13, 2026 21:41
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.

2 participants