Skip to content

Merge meta.yaml and devfile.yaml #26

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

Closed
wants to merge 1 commit into from

Conversation

GeekArthur
Copy link
Contributor

@GeekArthur GeekArthur commented Nov 23, 2020

Signed-off-by: jingfu wang [email protected]

Fixes devfile/api#172

This PR is used to move fields from meta.yaml to devfile.yaml in terms of documentation.

@GeekArthur GeekArthur self-assigned this Nov 23, 2020
@openshift-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: GeekArthur
To complete the pull request process, please assign after the PR has been reviewed.
You can assign the PR to them by writing /assign 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

Copy link
Member

@johnmcollier johnmcollier left a comment

Choose a reason for hiding this comment

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

I think these changes need to be made in the github.com/devfile/api repo? As this json file is copied automatically from the generated json spec each time changes are merged into devfile/api

@GeekArthur
Copy link
Contributor Author

I think these changes need to be made in the github.com/devfile/api repo? As this json file is copied automatically from the generated json spec each time changes are merged into devfile/api

I think the changes for devfile.json in this repo is only for documentation, basically what is does is to guide the docs generator to generate the html files so that the new devfile schema can be deployed and displayed on our public website.

@GeekArthur
Copy link
Contributor Author

GeekArthur commented Dec 1, 2020

@johnmcollier https://github.com/devfile/docs/blob/master/generate-api-reference.js#L12 here is the place how this repo uses the devfile.json that we change.

@johnmcollier
Copy link
Member

johnmcollier commented Dec 1, 2020

@GeekArthur This CI job https://github.com/devfile/api/blob/master/.github/workflows/ci.yaml#L66 publishes the devfile.json to this repository whenever the devfile schema has been modified, so any changes in here would get overwritten whenever the job is run.

If you're adding new fields to the metadata field of the devfile spec, wouldn't we need to deliver the changes to https://github.com/devfile/api/blob/1103496bda97425017e4f7fb01e4896ecfa2b5d8/pkg/apis/workspaces/v1alpha2/devworkspace_types.go#L73

@GeekArthur
Copy link
Contributor Author

@GeekArthur This CI job https://github.com/devfile/api/blob/master/.github/workflows/ci.yaml#L66 publishes the devfile.json to this repository whenever the devfile schema has been modified, so any changes in here would get overwritten whenever the job is run.

If you're adding new fields to the metadata field of the devfile spec, wouldn't we need to deliver the changes to https://github.com/devfile/api/blob/1103496bda97425017e4f7fb01e4896ecfa2b5d8/pkg/apis/workspaces/v1alpha2/devworkspace_types.go#L73

Ah, I was missing the CI part in API repo, I am gonna make the changes on API repo, thanks for pointing that out.

@GeekArthur
Copy link
Contributor Author

The changes need to made on API repo as the API repo CI is responsible for syncing the devfile.json.

@GeekArthur GeekArthur closed this Dec 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Discuss regarding merging meta.yaml and devfile.yaml
3 participants