Skip to content

Commit

Permalink
Merge pull request #599 from dmikusa/project-toml
Browse files Browse the repository at this point in the history
Add missing `schema-version` properties
  • Loading branch information
AidanDelaney committed Jul 18, 2023
2 parents 0253e55 + 4be5ebb commit ddfcca0
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 9 deletions.
18 changes: 9 additions & 9 deletions content/docs/app-developer-guide/specify-buildpacks.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ summary="Learn how to specify exactly what buildpacks are used during the build

You may specify exactly what buildpacks are used during the build process by referencing them with a URI in any of the following formats.

| Type | Format |
|----- |------- |
| Relative | `<path>` |
| Filesystem | `file://[<host>]/<path>` |
| URL | `http[s]://<host>/<path>` |
| Docker | `docker://[<host>]/<path>[:<tag>⏐@<digest>]` |
| CNB Builder Resource | `urn:cnb:builder[:<id>[@<version>]]` |
| CNB Registry Resource | `urn:cnb:registry[:<id>[@<version>]]` |
| Type | Format |
| --------------------- | -------------------------------------------- |
| Relative | `<path>` |
| Filesystem | `file://[<host>]/<path>` |
| URL | `http[s]://<host>/<path>` |
| Docker | `docker://[<host>]/<path>[:<tag>⏐@<digest>]` |
| CNB Builder Resource | `urn:cnb:builder[:<id>[@<version>]]` |
| CNB Registry Resource | `urn:cnb:registry[:<id>[@<version>]]` |

##### Fallback Behavior

Expand Down Expand Up @@ -60,7 +60,7 @@ The [`project.toml`][project-toml] format allows for Buildpack URIs to be specif

```toml
[_]
schema-version = "0.3"
schema-version = "0.2"
id = "sample-java-maven-app"
name = "Sample Java App"
version = "1.0.0"
Expand Down
2 changes: 2 additions & 0 deletions content/docs/app-developer-guide/using-project-descriptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ file at the root of the application. For more on `gitignore` matching see [these

```toml
[_]
schema-version = "0.2"
id = "io.buildpacks.bash-script"
name = "Bash Script"
version = "1.0.0"
Expand Down Expand Up @@ -68,6 +69,7 @@ Below is an expanded `project.toml`, with an additional buildpack and environmen

```toml
[_]
schema-version = "0.2"
id = "io.buildpacks.bash-script"
name = "Bash Script"
version = "1.0.0"
Expand Down
3 changes: 3 additions & 0 deletions content/docs/reference/config/project-descriptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ The schema for the `project descriptor` is:
- #### `_` _(table, optional)_
A configuration table for a project.

- **`schema-version`** _(string, optional)_\
A version identifier for the schema of the `_` table and structure of the project descriptor file. It is a string that follows the format of the [Buildpack API Version](https://github.com/buildpacks/spec/blob/main/buildpack.md#buildpack-api-version). The schema is documented [in the project descriptor specification](https://github.com/buildpacks/spec/blob/main/extensions/project-descriptor.md#schema-version) and is presently `0.2`.

- **`id`** _(string, optional)_\
A machine readable identifier for the `project`. For example, `com.example.myservice`.

Expand Down

0 comments on commit ddfcca0

Please sign in to comment.