Skip to content

Commit 52bdac8

Browse files
authored
docs: update language-onboarding guide (#1900)
The language onboarding guide will now be the source of truth for all container contracts. It is during language onboarding that this information is particularily useful and it does not make sense to have this information dupilicated. Additionally: - Filled in a minor gap mentioned in the old doc about logging from the container. - Removed a TODO as the guide already mentions global file edits. Fixes: #1828
1 parent ccfcfd9 commit 52bdac8

File tree

2 files changed

+4
-181
lines changed

2 files changed

+4
-181
lines changed

doc/container-contract.md

Lines changed: 0 additions & 177 deletions
This file was deleted.

doc/language-onboarding.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ it must have a binary entrypoint that can accept the arguments passed by Librari
6666
6767
A successful container invocation is expected to exit with a code of `0`. Any non-zero exit code will be treated as an
6868
error and will halt the current workflow. If a container would like to send an error message back to librarian it can do
69-
so by including a field in the various response files outlined below.
69+
so by including a field in the various response files outlined below. Additionally any logs sent to stderr/stdout will
70+
be surfaced to the CLI.
7071

7172
The following sections detail the contracts for each container command.
7273

@@ -79,9 +80,8 @@ The container is expected to produce up to two artifacts:
7980

8081
* A `configure-response.json` file, which is derived from the `configure-request.json` and contains language-specific
8182
details. This response will be committed back to the `state.yaml` file by Librarian.
82-
* Any "side-configuration" files that the language may need for its libraries. These should be written to the `/input` mount, which corresponds to the `.librarian/generator-input` directory in the language repository.
83-
84-
TODO: Global file edits
83+
* Any "side-configuration" files that the language may need for its libraries. These should be written to the `/input`
84+
mount, which corresponds to the `.librarian/generator-input` directory in the language repository.
8585

8686
**Contract:**
8787

0 commit comments

Comments
 (0)