Skip to content

Commit 590e610

Browse files
authored
doc: update language onboarding guide (#1702)
Some last minute changes to the release design.
1 parent 946e550 commit 590e610

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

doc/language-onboarding.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -255,21 +255,26 @@ The `release-init` command is the core of the release workflow. After Librarian
255255
the commits for a release, it invokes this container command to apply the necessary changes to the repository.
256256

257257
The container command's primary responsibility is to update all required files with the new version and commit
258-
information. This includes, but is not limited to, updating `CHANGELOG.md` files, bumping version numbers in metadata
259-
files (e.g., `pom.xml`, `package.json`), and updating any global files that reference the libraries being released.
258+
information for libraries that have the `release_triggered` set to true. This includes, but is not limited to, updating
259+
`CHANGELOG.md` files, bumping version numbers in metadata files (e.g., `pom.xml`, `package.json`), and updating any
260+
global files that reference the libraries being released.
260261

261262
**Contract:**
262263

263264
| Context | Type | Description |
264265
| :----------- | :------------------ | :------------------------------------------------------------------------------ |
265266
| `/librarian` | Mount (Read/Write) | Contains `release-init-request.json`. Container writes back a `release-init-response.json`. |
266-
| `/repo` | Mount (Read/Write) | The entire language repository, allowing the container to make any necessary global edits. |
267+
| `/repo` | Mount (Read) | Parts of the language repo. This directory will contain all directories that make up a library, the .librarian folder, and any global file declared in the `config.yaml`. |
267268
| `/output` | Mount (Write) | Any files updated during the release phase should be moved to this directory, preserving their original paths. |
268269
| `command` | Positional Argument | The value will always be `release-init`. |
269270
| flags. | Flags | Flags indicating the locations of the mounts: `--librarian`, `--repo`, `--output` |
270271

271272
**Example `release-init-request.json`:**
272273

274+
The request will have entries for all libraries configured in the state.yaml -- this information may be needed for any
275+
global file edits. The libraries that are being released will be marked by the `release_triggered` field being set to
276+
`true`.
277+
273278
```json
274279
{
275280
"libraries": [
@@ -303,7 +308,8 @@ files (e.g., `pom.xml`, `package.json`), and updating any global files that refe
303308
"source_roots": [
304309
"secretmanager",
305310
"other/location/secretmanager"
306-
]
311+
],
312+
"release_triggered": true
307313
}
308314
]
309315
}

0 commit comments

Comments
 (0)