Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add action name to ScopeDoctorGroup documentation #64

Merged
merged 1 commit into from
Feb 24, 2024
Merged

Add action name to ScopeDoctorGroup documentation #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/docs/models/ScopeDoctorGroup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ spec:
- brew
actions:
- description: Node Version
name: node-version
check:
paths:
- '.npmrc'
Expand All @@ -34,6 +35,7 @@ spec:
helpUrl: https://go.example.com/get-help
required: false
- description: Install packages
name: yarn
check:
paths:
- 'package.json'
Expand Down Expand Up @@ -69,6 +71,7 @@ To target a script relative to the group it must start with `.`, and giving a re

- `.spec.action` a series of steps to check and fix for the group.
- `.spec.needs[]` an array of names required before this group can run.
- `.spec.action[].name` a short name to refer to the action
- `.spec.action[].required` default true, when true action failing check & fix will stop all execution.
- `.spec.action[].check.paths` A list of globs to check for a change.
- `.spec.action[].check.commands` A list of commands to execute, using the exit code to determine if changes are needed.
Expand Down
Loading