Copying from that comment because of GitHub's terrible folding behavior:

I think inserting at the end of the pre-existing YAML content will be suboptimal in some cases. For example, if an audit suggests adding an explicit permissions: {} block where none exists, this would result in us adding permissions: {} at the very bottom of the workflow file, rather than the top (which is the popular convention).

Given that, we probably want a RootAdditionDisposition enum (that name is terrible, alternatives welcome!) that allows top-level fixes to suggest their insertion point. For example:

enum RootAdditionDisposition {
  /// Insert at the top of the document, following any comments.
  Top,
  /// Insert before `jobs:` but after any other document content.
  BeforeJobs,
  /// Insert at the bottom of the document.
  Bottom,
}
...and from there, a Fix that proposes permissions: {} will probably want BeforeJobs.

Thoughts?

However, that's probably not the best approach anymore -- the best approach now is probably to define RootAdditionDisposition::Top relative to a "well-known" key for each file type, e.g. on: for workflow definitions.

Uh oh!

Fix mode: situation top-level patches in reasonable locations #1235

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions