enh: add documentation for snap-in build config #41
Conversation
There was a problem hiding this comment.
Need to add the new page to the sidebar config. @starlightknown can help with that.
| Build configuration is used to pass values during the snap-in build process. The values are present as environment variables. This is useful if the snap-in requires libraries that | ||
| are either private or from different npm registry than the default. |
There was a problem hiding this comment.
Build configuration is used to pass values .... - The "pass values" phrase doesn't seem correct. Should we instead rephrase it as Build configuration is used to configure the build process of the Snap-In. For e.g. It can be used to set the environment variables used during the build process. This is useful if ....
| `type` can either be `constant` or `keyring`. | ||
|
|
||
| `value` is either the actual value of the environment variable or name of the developer keyring that | ||
| contains the secret depending on the type being `constant` or `keyring`. |
There was a problem hiding this comment.
Should we also link to the documentation page for build_configuration?
| Build config is a way to provide data to the snap-in build process. Currently, the only way to send data | ||
| is through environment variables that the build process has access to. | ||
|
|
Co-authored-by: Ben Colborn <[email protected]>
|
Are we ready to release the feature to the public? |
| ``` | ||
|
|
||
| Since "AUTH_TOKEN" is sensitive information that should not be hardcoded in the manifest, | ||
| the developer can instead mention the name of the developer keyring and during snap-in version creation |
There was a problem hiding this comment.
| the developer can instead mention the name of the developer keyring and during snap-in version creation | |
| the developer can instead mention the name of the developer keyring and during snap-in version creation |
and during?
| @@ -0,0 +1,61 @@ | |||
| The build configuration is used to configure the build process of the snap-in. For example, it can be used to set the environment variables used during the build process. | |||
There was a problem hiding this comment.
The definition is tautological: build configuration configures builds. The intro paragraph should have comprehensive statements, not an example. What else does it do besides set environment variables? I don't see anything else covered in this doc.
Co-authored-by: Ben Colborn <[email protected]>
Co-authored-by: Ben Colborn <[email protected]>
|
@navneel99 is this PR still relevant? Please either take it forward or close it. |
|
Hello, we currently don't want to make this public to 3P, but want to keep it internal to DevRev |
Adding documentation for snap-in's build config.
Work-item
https://app.devrev.ai/devrev/works/ISS-84458