Skip to content

roles: [read] documented as available but rejected by compiler #23567

@PureWeen

Description

@PureWeen

Summary

The frontmatter reference lists read as an available role, but the compiler rejects it. Is read role support planned, or should the docs be updated to remove it?

Details

The docs list read as available in two places:

Line 244 (on.roles:): Available roles: admin, maintainer, write, read, all

Line 292 (skip-roles:): Available roles: admin, maintainer, write, read

The compiler (v0.62.2) rejects it:

on:
  workflow_dispatch:
  roles: [read]
error: 'on' (line 4, col 4): '0': value must be one of 'admin', 'maintainer', 'maintain', 'write', 'triage'

There are also a couple of other mismatches between docs and compiler:

  • triage — accepted by compiler, not listed in docs
  • maintain — accepted by compiler as an alias for maintainer, not listed in docs

Is there a plan to add read to the compiler (matching the docs), or should the docs be corrected to reflect the current compiler behavior?

Related

Metadata

Metadata

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions