Skip to content

Add blog-release-series skill (capture this week's lessons)#5134

Merged
shai-almog merged 1 commit into
masterfrom
skill-blog-release-series
May 31, 2026
Merged

Add blog-release-series skill (capture this week's lessons)#5134
shai-almog merged 1 commit into
masterfrom
skill-blog-release-series

Conversation

@shai-almog
Copy link
Copy Markdown
Collaborator

Summary

Adds skills/blog-release-series/ to capture the workflow and editorial lessons from the 2026-05-29 release cycle so the next release week's posts ship as a single batch PR instead of as a chain of sibling PRs that each edit the previous post's wrap-up.

Why

This week's cycle (intro #5074 already merged; workflow #5086 merged; platform APIs #5087 and codegen #5088 in review) shipped as stacked PRs. Every follow-up needed to:

  • Modify the previous post's wrap-up to add a forward link.
  • Be rebased with git rebase --onto <merged-commit> after each merge to skip the squash-merged history.
  • Have any weekday-based prose ("Monday's post") hand-edited if the schedule shifted.

That pattern produced repeated merge conflicts and required multiple force-pushes per follow-up. The skill recommends moving to one batch PR per week, with all posts dated for their publish day and HUGO_BUILD_FUTURE=true (already wired into website-docs.yml for pull_request events) rendering them on the Cloudflare preview URL while the live site keeps them hidden until their date.

What's in the skill

  • Recommended PR structure (one PR per release week).
  • Front-matter conventions, including the YAML colon quoting rule that bit Blog: build-time codegen (router, ORM, mappers, binder, SVG/Lottie) #5088.
  • Cross-post linking pattern that survives schedule shifts (tomorrow's post / yesterday's post); sketch of a Hugo next / previous partial that would replace hand-written links entirely.
  • Hugo preview workflow (local hugo server --buildFuture; the Cloudflare preview URL).
  • Screenshot conventions, including reuse of the existing test fixtures under scripts/{ios,android,javase}/screenshots*/ and a PIL crop / downscale example.
  • Animated-GIF recipe from the 2026-06-01 codegen post (frame interpolation, shared palette, 60 ms per frame).
  • Mermaid shortcode usage plus the partialCached gotcha that drove the inline-loader pattern.
  • A comprehensive editorial-rule section pulled from reviewer feedback across this week (no em-dashes, no first-person "I", no "knob"/"deep dive"/AI tropes, build-hint prose without codename1.arg., don't disparage the build cloud, cloud handles iOS builds so no local Mac is required, no half-shipped features, screenshots over ASCII, bind examples must show the form, ML-Kit-style per-cn1lib subsections, API-key handling rules).
  • A pre-merge checklist mapping each editorial rule to a grep command or preview spot-check.

Files

  • skills/blog-release-series/SKILL.md — the skill content.
  • skills/blog-release-series/agents/openai.yaml — interface block matching the existing developer-guide-vale and ios-cn1ss-xcode-debug skills.

Test plan

  • Skill renders correctly when listed under skills/.
  • The pre-merge checklist grep commands are runnable against a sample post (em-dash check, first-person check, codename1.arg. check).
  • Next week's release: open the skill, follow the batch-PR recipe, see whether it reduces the round-trip count compared to this week.

Captures the workflow and editorial lessons from the 2026-05-29
release cycle so the next week's release post + daily follow-ups
ship as a single batch PR rather than as a stack of sibling PRs
that each edit the previous post's wrap-up to add a forward link.

The skill covers:

- Recommended PR structure (one PR per release week, every post as
  a separate .md, every per-post asset under static/blog/<slug>/).
- Front-matter conventions (quoted titles when they contain a
  colon, slug == filename == url, feed_html mirrors description).
- Cross-post linking pattern (use "tomorrow's post" / "yesterday's
  post" so a schedule shift doesn't require editing every
  reference; sketch of a Hugo partial that would replace the
  hand-written links entirely if the next batch wants it).
- Hugo preview workflow: local `hugo server --buildFuture` and the
  Cloudflare PR preview URL the website-docs.yml workflow already
  posts on every PR.
- Screenshot conventions: reuse the existing test fixtures under
  scripts/{ios,android,javase}/screenshots*/ rather than asking for
  fresh captures; a worked PIL crop + downscale example.
- Animated-GIF recipe from the 2026-06-01 codegen post (crop the
  6-cell grid, mask labels, interpolate, share palette, 60ms / frame
  loop), preserved in an appendix.
- Mermaid shortcode usage + the partialCached gotcha that drove the
  inline loader.
- Editorial rules from reviewer feedback: no em-dashes, no first-
  person "I", no "knob"/"deep dive"/AI tropes, build hints written
  without codename1.arg. prefix, don't disparage the build cloud,
  cloud handles the iOS build (no local Mac needed for cloud-built
  iOS apps), no half-shipped features, real screenshots over ASCII,
  bind examples must include the form, ML-Kit-style multi-cn1lib
  coverage as per-cn1lib subsections, API-key handling rules, etc.
- Pre-merge checklist mapping each editorial rule to a grep command
  or preview-URL spot-check.

The skill lives under skills/ alongside the existing
developer-guide-vale and ios-cn1ss-xcode-debug skills, with a
matching agents/openai.yaml interface block.
@shai-almog shai-almog merged commit e06da5f into master May 31, 2026
9 checks passed
@shai-almog shai-almog deleted the skill-blog-release-series branch May 31, 2026 01:37
@github-actions
Copy link
Copy Markdown
Contributor

✅ Continuous Quality Report

Test & Coverage

Static Analysis

  • SpotBugs [Report archive]
    • ByteCodeTranslator: 0 findings (no issues)
    • android: 0 findings (no issues)
    • codenameone-maven-plugin: 0 findings (no issues)
    • core-unittests: 0 findings (no issues)
    • ios: 0 findings (no issues)
  • PMD: 0 findings (no issues) [Report archive]
  • Checkstyle: 0 findings (no issues) [Report archive]

Generated automatically by the PR CI workflow.

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