Skip to content

[docs-scanner] Confusing temporal framing in cache write restrictions section #26467

Open

Description

@docker-agent

File: content/manuals/build/ci/github-actions/cache.md

Issue

The "Cache write restrictions" section describes GitHub's cache access policy changes using past-tense framing that makes it unclear when these policies apply:

Cache export requires write access to the GitHub Actions cache. GitHub gives events such as issue_comment and pull_request_target read-only cache access by default when they run in the default-branch context.

Then later:

This also affects pull_request workflows with types: [closed] when a pull request is merged into the default branch: the run uses the target branch ref instead of the pull request merge ref. Regular pull_request runs using a merge ref retain read-write cache access by default. See GitHub's cache access policy.

The linked changelog is dated "2026-06-26" (future date), but the text describes these as current behaviors ("GitHub gives", "retain"). This creates confusion about whether these are:

  • Current GitHub policies
  • Future changes being announced
  • Past changes that are now in effect

Why this matters

Readers trying to troubleshoot cache write failures need to know whether these restrictions are currently in effect or are upcoming changes. The future-dated changelog link (2026-06-26) contradicts the present-tense description of the behavior, making it impossible to determine if this is the current state of GitHub Actions or a planned change.

Suggested fix

Clarify the temporal status:

  • If these policies are currently in effect: Update the changelog link to the correct date or remove the future date
  • If these are upcoming changes: Use future tense ("GitHub will give", "will retain") and clearly state when the changes take effect
  • Add a clear statement about when these restrictions were introduced or will be introduced

Found by nightly documentation quality scanner

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions