Skip to content

docs: update documentation for failure hooks, task conditionals, arguments validations and ignore errors features - #196

Merged
xmnlab merged 1 commit into
makim-org:mainfrom
ansh808s:docs/multiple-features
Feb 10, 2026
Merged

docs: update documentation for failure hooks, task conditionals, arguments validations and ignore errors features#196
xmnlab merged 1 commit into
makim-org:mainfrom
ansh808s:docs/multiple-features

Conversation

@ansh808s

Copy link
Copy Markdown
Member

Pull Request description

This PR aims to add documentation for following features:

How to test these changes

mkdocs serve

Pull Request checklists

This PR is a:

  • maintenance

About this PR:

  • it includes tests.
  • the tests are executed on CI.
  • the tests generate log file(s) (path).
  • pre-commit hooks were executed locally.
  • this PR requires a project documentation update.

Author's checklist:

  • I have reviewed the changes and it contains no misspelling.
  • The code is well commented, especially in the parts that contain more
    complexity.
  • New and old tests passed locally.

Additional information

Screenshot 2025-04-27 at 12 02 08 PM Screenshot 2025-04-27 at 12 02 49 PM

Reviewer's checklist

Copy and paste this template for your review's note:

## Reviewer's Checklist

- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved .

@github-actions

github-actions Bot commented May 3, 2025

Copy link
Copy Markdown

This pull request has been marked as stale because it has been
inactive for more than 5 days. Please update this pull request
or it will be automatically closed in 5 days.

@github-actions github-actions Bot added the stale label May 3, 2025
@github-actions github-actions Bot closed this May 8, 2025
@xmnlab xmnlab reopened this Jul 11, 2025
@github-actions github-actions Bot removed the stale label Jul 12, 2025
@ansh808s
ansh808s force-pushed the docs/multiple-features branch from 50a2f09 to 79ed85e Compare July 16, 2025 06:22
@github-actions

Copy link
Copy Markdown

This pull request has been marked as stale because it has been
inactive for more than 5 days. Please update this pull request
or it will be automatically closed in 5 days.

@github-actions github-actions Bot added the stale label Jul 22, 2025
@github-actions github-actions Bot closed this Jul 27, 2025
@ansh808s ansh808s reopened this Aug 15, 2025
@github-actions github-actions Bot removed the stale label Aug 16, 2025
@ansh808s
ansh808s force-pushed the docs/multiple-features branch from 79ed85e to 1a6c90d Compare August 25, 2025 05:03
@github-actions

Copy link
Copy Markdown

This pull request has been marked as stale because it has been
inactive for more than 30 days. Please update this pull request
or it will be automatically closed soon.

@github-actions github-actions Bot added the stale label Sep 25, 2025
@xmnlab

xmnlab commented Nov 1, 2025

Copy link
Copy Markdown
Contributor

@ansh808s is this pr ready for review?

@github-actions github-actions Bot removed the stale label Nov 2, 2025
@ansh808s

ansh808s commented Nov 2, 2025

Copy link
Copy Markdown
Member Author

@ansh808s is this pr ready for review?

Yes @xmnlab this is ready for review

@github-actions

github-actions Bot commented Dec 3, 2025

Copy link
Copy Markdown

This pull request has been marked as stale because it has been
inactive for more than 30 days. Please update this pull request
or it will be automatically closed soon.

@github-actions github-actions Bot added the stale label Dec 3, 2025
@xmnlab

xmnlab commented Dec 8, 2025

Copy link
Copy Markdown
Contributor

Not stale

@github-actions github-actions Bot removed the stale label Dec 9, 2025
@github-actions

github-actions Bot commented Jan 8, 2026

Copy link
Copy Markdown

This pull request has been marked as stale because it has been
inactive for more than 30 days. Please update this pull request
or it will be automatically closed soon.

@github-actions github-actions Bot added the stale label Jan 8, 2026
@xmnlab

xmnlab commented Jan 22, 2026

Copy link
Copy Markdown
Contributor

I will review this again soon

@github-actions github-actions Bot removed the stale label Jan 23, 2026
@xmnlab
xmnlab force-pushed the docs/multiple-features branch from 1a6c90d to bbd65d4 Compare February 9, 2026 20:42
@xmnlab
xmnlab force-pushed the docs/multiple-features branch from bbd65d4 to 87a1871 Compare February 10, 2026 12:00
@github-actions

Copy link
Copy Markdown

OSL ChatGPT Reviewer

NOTE: This is generated by an AI program, so some comments may not make sense.

docs/features.md

  • The example uses a hyphenated arg key with dot access, which will typically parse as subtraction, not a field. Replace ${{ args.node-count }} with ${{ args["node-count"] }} to avoid a runtime/template error. (L.78)

  • The JSON Schema link anchor appears broken/truncated. Use the correct anchor for numeric validations: https://json-schema.org/draft/2020-12/json-schema-validation#name-validation-keywords-for-numeric-instances (L.60)

  • Hooks semantics: Please clarify whether post-run executes on task failure and whether failure hooks run if a pre-run hook fails. Also ensure the “Skipping Hooks” section mentions how to skip failure hooks for parity with pre/post. (Near the hooks section header around L.200)


docs/spec.md

  • Args type naming inconsistency: examples switched from "str" to "string". Please define and standardize the canonical type identifiers (e.g., string, integer, boolean) and update all examples accordingly to avoid breaking behavior or confusion (L.126).

  • Validation keywords mismatch with JSON Schema: you reference JSON Schema but use kebab-case keys like min-length/max-length. JSON Schema uses camelCase (minLength/maxLength/pattern, etc.). Either align to JSON Schema names or clearly document the mapping to avoid incorrect implementations (L.129). Also, the link anchor appears broken; consider pointing to the specific “Validation keywords for strings” section: https://json-schema.org/draft/2020-12/json-schema-validation#name-validation-keywords-for-strings (L.121).

  • Task-level if key added but not specified: you introduced tasks.if in the schema, but there’s no section describing its syntax, evaluation context, and effect (e.g., does it skip the task entirely, how are vars resolved, how do failures in condition evaluation behave?). Please document this to avoid divergent implementations (L.82).

  • Hooks semantics with ignore-errors: clarify whether failure hooks fire when a task fails with options.ignore-errors: true, and whether failure hooks also run on pre-run hook failures. Also define execution order guarantees among pre-run/post-run/failure hooks (L.166).

  • Example failure command: using assert 1 == 2 isn’t portable in shells and may mislead users. Suggest replacing with a portable failure, e.g., false or exit 1 (L.442).


@xmnlab
xmnlab merged commit 9bf4b6c into makim-org:main Feb 10, 2026
25 of 26 checks passed
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.

2 participants