Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SHIP-0004: Build Environment Variables #53

Closed
wants to merge 1 commit into from
Closed

SHIP-0004: Build Environment Variables #53

wants to merge 1 commit into from

Conversation

coreydaley
Copy link
Member

Adding documentation for SHIP-0004: Build Environment Variables

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Sep 27, 2021

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign sbose78 after the PR has been reviewed.
You can assign the PR to them by writing /assign @sbose78 in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coreydaley
Copy link
Member Author

/assign @adambkaplan @otaviof

@coreydaley coreydaley added documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 27, 2021
@coreydaley
Copy link
Member Author

Documentation for shipwright-io/build#817

@adambkaplan
Copy link
Member

@coreydaley for API docs we write the doc in the repository with the code (shipwright-io/build in this case), and then sync the documentation to the website at release time.

I did this manually the last time - we have a TODO to automate this in #29.

- name: EXAMPLE_VAR_1
value: "example-value-1"
- name: EXAMPLE_VAR_2
value: "example-value-2"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aside from the where you initially specify content comment from @adambkaplan - my comment in the shipwright-io/build PR about the type of this field would come into play

if this field is going to be k8s corev1.EnvVar, then we need more examples to show getting content from configmaps, secrets, etc.

or our doc cites those are not supported

if, however, we go with a a simpler type that is a subset of corev1.EnvVar, then these examples seem sufficient

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved documentation to shipwright-io/build#817

@coreydaley
Copy link
Member Author

/close
Added documentation to shipwright-io/build#817

@openshift-ci openshift-ci bot closed this Sep 28, 2021
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Sep 28, 2021

@coreydaley: Closed this PR.

In response to this:

/close
Added documentation to shipwright-io/build#817

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants