Skip to content

Commit

Permalink
Merge pull request #196 from natalieparellano/exit-codes
Browse files Browse the repository at this point in the history
Condense lifecycle exit codes
  • Loading branch information
ekcasey authored Mar 18, 2021
2 parents a36865b + 3cd5418 commit a298cf3
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,10 +318,10 @@ Usage:
| `0` | Success
| `11` | Platform API incompatibility error
| `12` | Buildpack API incompatibility error
| `1-10`, `13-99` | Generic lifecycle errors
| `100` | All buildpacks groups have failed to detect w/o error
| `101` | All buildpack groups have failed to detect and at least one buildpack has errored
| `102-199` | Detection-specific lifecycle errors
| `1-10`, `13-19` | Generic lifecycle errors
| `20` | All buildpacks groups have failed to detect w/o error
| `21` | All buildpack groups have failed to detect and at least one buildpack has errored
| `22-29` | Detection-specific lifecycle errors

The lifecycle:
- SHALL detect a single group from `<order>` and write it to `<group>` using the [detection process](buildpack.md#phase-1-detection) outlined in the Buildpack Interface Specification
Expand Down Expand Up @@ -378,8 +378,8 @@ Usage:
| `0` | Success
| `11` | Platform API incompatibility error
| `12` | Buildpack API incompatibility error
| `1-10`, `13-99` | Generic lifecycle errors
| `200-299` | Analysis-specific lifecycle errors
| `1-10`, `13-19` | Generic lifecycle errors
| `30-39` | Analysis-specific lifecycle errors

- The lifecycle MUST write [analysis metadata](#analyzedtoml-toml) to `<analyzed>` if `<image>` is accessible.
- **If** `<skip-layers>` is `true` the lifecycle MUST NOT perform layer analysis.
Expand Down Expand Up @@ -435,8 +435,8 @@ Usage:
| `0` | Success
| `11` | Platform API incompatibility error
| `12` | Buildpack API incompatibility error
| `1-10`, `13-99` | Generic lifecycle errors
| `300-399` | Restoration-specific lifecycle errors
| `1-10`, `13-19` | Generic lifecycle errors
| `40-49` | Restoration-specific lifecycle errors

##### Layer restoration
For each layer metadata file found in the `<layers>` directory, the lifecycle:
Expand Down Expand Up @@ -484,9 +484,9 @@ Usage:
| `0` | Success
| `11` | Platform API incompatibility error
| `12` | Buildpack API incompatibility error
| `1-10`, `13-99` | Generic lifecycle errors
| `401` | Buildpack build error
| `400`, `402-499`| Build-specific lifecycle errors
| `1-10`, `13-19` | Generic lifecycle errors
| `51` | Buildpack build error
| `50`, `52-59`| Build-specific lifecycle errors

- The lifecycle SHALL execute all buildpacks in the order defined in `<group>` according process outlined in the [Buildpack Interface Specification](buildpack.md).
- The lifecycle SHALL add all invoked buildpacks to`<layers>/config/metadata.toml`.
Expand Down Expand Up @@ -557,8 +557,8 @@ Usage:
| `0` | Success
| `11` | Platform API incompatibility error
| `12` | Buildpack API incompatibility error
| `1-10`, `13-99` | Generic lifecycle errors
| `500-599`| Export-specific lifecycle errors
| `1-10`, `13-19` | Generic lifecycle errors
| `60-69`| Export-specific lifecycle errors

- The lifecycle SHALL write the same app image to each `<image>` tag
- The app image:
Expand Down Expand Up @@ -644,12 +644,12 @@ Outputs produced by `creator` are identical to those produced by `exporter`, wit
| `0` | Success
| `11` | Platform API incompatibility error
| `12` | Buildpack API incompatibility error
| `1-10`, `13-99` | Generic lifecycle errors
| `100-199`| Detection-specific lifecycle errors
| `200-299`| Analysis-specific lifecycle errors
| `300-399`| Restoration-specific lifecycle errors
| `400-499`| Build-specific lifecycle errors
| `500-599`| Export-specific lifecycle errors
| `1-10`, `13-19` | Generic lifecycle errors
| `20-29`| Detection-specific lifecycle errors
| `30-39`| Analysis-specific lifecycle errors
| `40-49`| Restoration-specific lifecycle errors
| `50-59`| Build-specific lifecycle errors
| `60-69`| Export-specific lifecycle errors


#### `rebaser`
Expand Down Expand Up @@ -694,8 +694,8 @@ Usage:
| `0` | Success
| `11` | Platform API incompatibility error
| `12` | Buildpack API incompatibility error
| `1-10`, `13-99` | Generic lifecycle errors
| `600-699`| Rebase-specific lifecycle errors
| `1-10`, `13-19` | Generic lifecycle errors
| `70-79`| Rebase-specific lifecycle errors

- The lifecycle SHALL write the same app image to each `<image>` tag
- The rebased app image SHALL be identical to `<image>`, with the following modifications:
Expand Down Expand Up @@ -755,7 +755,7 @@ If the launcher errors before executing the process it will have one of the foll
|-----------|-------|
| `11` | Platform API incompatibility error
| `12` | Buildpack API incompatibility error
| `700-799`| Launch-specific lifecycle errors
| `80-89`| Launch-specific lifecycle errors

Otherwise, the exit code shall be the exit code of the launched process.

Expand Down

0 comments on commit a298cf3

Please sign in to comment.