Simple Project descriptor by jkutner · Pull Request #25 · buildpacks/rfcs

jkutner · 2019-09-26T17:58:47Z

Readable

Signed-off-by: Joe Kutner <jpkutner@gmail.com> wip wip wip wip

Signed-off-by: Joe Kutner <jpkutner@gmail.com>

Signed-off-by: Terence Lee <hone02@gmail.com>

Signed-off-by: Joe Kutner <jpkutner@gmail.com>

text/0000-project-descriptor.md

Signed-off-by: Joe Kutner <jpkutner@gmail.com>

jkutner · 2019-10-04T19:21:34Z

Updated based on discussion in working group. Changes include:

added value for env vars
changed processes.cmd to processes.command and included all other fields from launch.toml
Removed stack
Removed publish
Removed optional
Moved license, author, source, etc under [metadata]
Added [extensions]

jkutner · 2019-10-04T19:28:37Z

There is an unresolved question regarding how to tag multiple [[images]] w/o:

requiring developers to commit a registry URL/host to Git
requiring developers to manually retag the image after building

One of the options, which I'm proposing as a solution, is to have a platform use two value to construct the full image tag: [[images]] id and a new --registry flag on pack build. Thus, you might see a project.toml containing this:

[[images]]
id = "myorg/gateway"

[[images]]
id = "myorg/service1"

A user could then run:

$ pack buildpack myimage --registry gcr.io --publish

Signed-off-by: Joe Kutner <jpkutner@gmail.com>

jkutner · 2019-10-22T13:37:48Z

I've added an example using image id prefix/suffix as discussed.

Signed-off-by: Joe Kutner <jpkutner@gmail.com>

jkutner · 2019-10-30T20:53:03Z

@sclevine @nebhale @hone @ekcasey ready for re-review

jkutner · 2019-10-30T20:55:31Z

I've moved the metadata keys in to [project] based on the precedent found in pom.xml and package.json.

I've added ref and suffix keys to [[images]] as described in WG. I chose ref because I was afraid tag too strongly referred to a complete tag. Happy to change that though.

sclevine · 2019-10-31T17:48:13Z

text/0000-project-descriptor.md

+exclude = ["<string>"]
+
+[[images]]
+ref = "<string>"


Small issue with ref vs tag: only tags are valid in this field, and other kinds of ref are not valid.
E.g., gcr.io/example/myapp@sha256:2342ab... is not valid, because it's not possible to know the digest ahead of time.

i'm fine with tag then

sclevine · 2019-10-31T17:50:40Z

text/0000-project-descriptor.md

+
+```toml
+[project]
+id = "<string>"


Were we going to replace id/version with ref (or tag, noting my comment below), and then combine it with the individual refs and suffixs?

i think i'm fine with that. i'd probably move to make it optional though (which means there's no required id or tag, which might be a problem).

sclevine · 2019-10-31T17:52:36Z

text/0000-project-descriptor.md

+```toml
+[project]
+id = "io.buildpacks.my-app"
+version = "0.1"


Seems unusual to require a version to be checked into a git repo for project.toml to be valid. That breaks certain release strategies.

sclevine · 2019-10-31T18:42:12Z

text/0000-project-descriptor.md

+
+## Example: Monorepos
+
+The `[[images]]` array of tables allows the buildpack lifecycle to generate more than one image per build. Each table in the array may contain configuration that defines a different image for different parts of the code. For example:


clarify per pack build, not lifecycle build

hone · 2019-10-31T18:56:36Z

From @jonjohnsonjr, Julia also has a Project.toml.

jkutner · 2019-12-05T20:07:43Z

Closing in favor of #32. We'll open a new RFC for [[images]], [[extensions]], buildpacks and other things.

[#43] Signed-off-by: Ben Hale <bhale@pivotal.io>

jkutner and others added 8 commits July 24, 2019 07:44

Created an RFC for project descriptor

0da24aa

Signed-off-by: Joe Kutner <jpkutner@gmail.com> wip wip wip wip

Change includes/excludes to generate an error when both are present

18b7fe2

Signed-off-by: Joe Kutner <jpkutner@gmail.com>

change images.name -> images.id

da7af56

Signed-off-by: Terence Lee <hone02@gmail.com>

add stacks into [[buildpacks]]

e3f0552

Signed-off-by: Terence Lee <hone02@gmail.com>

inline buildpack definition + stack

fadee81

Signed-off-by: Terence Lee <hone02@gmail.com>

Added full schema to project descriptor

0cc209e

Signed-off-by: Joe Kutner <jpkutner@gmail.com>

Remove path from project descriptor

110c995

Signed-off-by: Joe Kutner <jpkutner@gmail.com>

Clean up after forking from old RFC

86353dc

Signed-off-by: Joe Kutner <jpkutner@gmail.com>

jkutner changed the title ~~Project descriptor simple~~ Simple Project descriptor Sep 26, 2019

jkutner mentioned this pull request Sep 26, 2019

RFC: Project descriptor #16

Closed

josegonzalez reviewed Oct 2, 2019

View reviewed changes

text/0000-project-descriptor.md Show resolved Hide resolved

Updated based on discussion in the working group

3821b17

Signed-off-by: Joe Kutner <jpkutner@gmail.com>

nebhale requested review from ekcasey, hone, nebhale and sclevine October 16, 2019 19:43

Added definition around how images.id is used with multiple image tags

684f133

Signed-off-by: Joe Kutner <jpkutner@gmail.com>

jkutner force-pushed the project-descriptor-simple branch from 90d88e4 to 684f133 Compare October 22, 2019 13:37

jkutner mentioned this pull request Oct 23, 2019

Add support for .packignore file buildpacks/pack#210

Closed

Made changes to project.toml RFC based on feedback from WG

db9ccec

Signed-off-by: Joe Kutner <jpkutner@gmail.com>

sclevine reviewed Oct 31, 2019

View reviewed changes

jkutner mentioned this pull request Nov 15, 2019

Analysing app.json for setting buildpacks and default stack heroku/cnb-builder-images#26

Closed

jromero mentioned this pull request Dec 4, 2019

Exclude specified directories buildpacks/pack#403

Closed

jkutner mentioned this pull request Dec 5, 2019

Minimal project descriptor #32

Closed

jkutner closed this Dec 5, 2019

ekcasey mentioned this pull request Jan 22, 2020

Application descriptor buildpacks/spec#44

Closed

nebhale added a commit that referenced this pull request Feb 6, 2020

RFC #25

7934638

[#43] Signed-off-by: Ben Hale <bhale@pivotal.io>


		## Example: Monorepos

		The `[[images]]` array of tables allows the buildpack lifecycle to generate more than one image per build. Each table in the array may contain configuration that defines a different image for different parts of the code. For example:

Conversation

jkutner commented Sep 26, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jkutner commented Oct 4, 2019

Uh oh!

jkutner commented Oct 4, 2019

Uh oh!

jkutner commented Oct 22, 2019

Uh oh!

jkutner commented Oct 30, 2019

Uh oh!

jkutner commented Oct 30, 2019

Uh oh!

sclevine Oct 31, 2019

Choose a reason for hiding this comment

Uh oh!

jkutner Oct 31, 2019

Choose a reason for hiding this comment

Uh oh!

sclevine Oct 31, 2019

Choose a reason for hiding this comment

Uh oh!

jkutner Oct 31, 2019

Choose a reason for hiding this comment

Uh oh!

sclevine Oct 31, 2019

Choose a reason for hiding this comment

Uh oh!

sclevine Oct 31, 2019

Choose a reason for hiding this comment

Uh oh!

hone commented Oct 31, 2019

Uh oh!

jkutner commented Dec 5, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jkutner commented Sep 26, 2019 •

edited

Loading