feat(docs): Add workflow specification and schema#108
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds workflow file (
gilbert.yaml) specification in markdown format and file schema definitions in following formats:docs/spec/src/schema.d.ts: original source of truth schema in TypeScript.docs/spec/schema.tsp: Schema in TypeSpec format. Used to generate JSON schema file. Generated fromschema.d.ts.docs/spec/gilbert.schema.json: Final JSON schema. Generated from TypeSpec schema.The workflow formal spec is
docs/spec/workflow.md.Besides that, the PR includes following:
tools/post-process-schema.mjs: Script to patch JSON schema file for YAML language server support. Seedocs/man/schema_build.mdfor background.docs/spec/src: Source files with original brainstorming info, used to generate spec.