write-ok skill

Overview

This skill writes a deterministic OK file to out/ok.txt so downstream steps can detect a successful run. It provides a single, stable output that automated pipelines and checks can rely on. The behavior is minimal and reproducible across environments.

How this skill works

Running the provided script from the skill root executes a simple write operation that places the text "OK" into out/ok.txt. The script creates the out directory if needed and overwrites any existing ok.txt to ensure deterministic results. Downstream processes can read or assert the presence and content of out/ok.txt to validate completion.

When to use it

• Signal successful completion of a build, test, or agent step in a pipeline.
• Provide a simple, machine-checkable artifact for CI/CD gating.
• Synchronize multi-step workflows that need a deterministic success marker.
• Integrate with systems that poll or assert file-based readiness.

Best practices

• Run the script from the skill repository root to ensure the correct relative path.
• Treat out/ok.txt as a transient artifact; do not commit it to version control.
• Make sure downstream checks read the file content exactly (expecting "OK").
• Ensure file permissions allow the CI user or agent to write into the out directory.

Example use cases

• CI job writes out/ok.txt after successful tests; deploy step checks the file before proceeding.
• A multi-agent workflow where one agent signals completion by producing out/ok.txt for another agent to consume.
• Tooling that polls the workspace for a readiness file before executing resource-intensive tasks.
• Automated validation scripts that assert repository skills produce the expected artifact.

FAQ