Document project.toml #190
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dfreilich
force-pushed
the
165-project-toml
branch
from
34b333d to
3878976
Compare
dfreilich
commented
Aug 18, 2020
Comment on lines
+121
to
+122
| > **NOTE:** `project.toml` can't detect environment variables (so, for instance, if one ran `export FOO=BAR` and added | ||
| >`name=FOO` to the `project.toml`, it wouldn't detect any value set for `FOO`). |
There was a problem hiding this comment.
I'm not sure if this is a feature of a bug. Should project.toml detect env vars set? Should I open a bug in pack?
There was a problem hiding this comment.
This would be a feature request. I don't believe this is an expectation and given that this is a spec'd it would require an RFC.
Signed-off-by: David Freilich <dfreilich@vmware.com>
Signed-off-by: David Freilich <dfreilich@vmware.com>
Signed-off-by: David Freilich <dfreilich@vmware.com>
dfreilich
force-pushed
the
165-project-toml
branch
from
25d6e8d to
71ec273
Compare
jromero
approved these changes
Aug 19, 2020
Comment on lines
+121
to
+122
| > **NOTE:** `project.toml` can't detect environment variables (so, for instance, if one ran `export FOO=BAR` and added | ||
| >`name=FOO` to the `project.toml`, it wouldn't detect any value set for `FOO`). |
There was a problem hiding this comment.
This would be a feature request. I don't believe this is an expectation and given that this is a spec'd it would require an RFC.
Signed-off-by: Javier Romero <rjavier@vmware.com>
github-actions bot
pushed a commit
that referenced
this pull request
Aug 25, 2020
Document project.toml
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: David Freilich dfreilich@vmware.com
Resolves #165
This PR adds documentation for the
project.tomlfile, referred to as the project descriptor. It was proposed in buildpacks/rfcs#32 and is specified here.As part of this PR, I am adding project.toml documentation: