Skip to content

Generate the README screen from the quiz and tighten repository tooling - #1

Open
alxkm wants to merge 1 commit into
masterfrom
improve-readme-screen-and-ci
Open

alxkm wants to merge 1 commit into
masterfrom
improve-readme-screen-and-ci

Conversation

@alxkm

@alxkm alxkm commented Sep 26, 2026

Copy link
Copy Markdown
Owner

What this changes

  • README screen is generated. The banner and menu at the top of the README were a hand copy, one column out of their box. They are now rendered by ./gradlew readme from the same code the quiz uses, and readmeIsUpToDate fails if they drift.
  • Question count is generated. The badge, the first sentence and the banner used a hand-typed 166; all three now come from questions/.
  • Banner diagram. release and acquire sit in one column, so the happens-before edge reads as a single arrow.
  • Tooling. Dependabot for Gradle and Actions, a weekly and per-PR link check (most answers link into java-concurrency-patterns), a correction issue template, blank issues disabled, and permissions, concurrency and timeout-minutes on CI.

Checklist

  • ./gradlew test passes
  • ./gradlew readme was run, so the catalogue in README.md matches questions/

The screen at the top of the README was a hand copy that had drifted a
column out of its box, and its question count, like the badge and the
first sentence, was typed in by hand. All three are now rendered by
--export-readme and checked by readmeIsUpToDate.

The banner diagram now lines release and acquire up in one column, so
the happens-before edge reads as a single arrow.

Also: Dependabot for Gradle and Actions, a link check for the answers'
links into java-concurrency-patterns, a correction issue template,
least-privilege permissions, cancellation and a timeout for CI.
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.

1 participant