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

Package starter projects in offline registry #1203

Closed
Tracked by #329
mike-hoang opened this issue Jul 26, 2023 · 6 comments · Fixed by devfile/registry-support#179
Closed
Tracked by #329

Package starter projects in offline registry #1203

mike-hoang opened this issue Jul 26, 2023 · 6 comments · Fixed by devfile/registry-support#179
Assignees
Labels
area/registry Devfile registry for stacks and infrastructure

Comments

@mike-hoang
Copy link
Contributor

mike-hoang commented Jul 26, 2023

Which area/kind this issue is related to?

/area registry

Issue Description

This issue is part of the EPIC #329 and focuses on implementing the first stage of the design doc.

Build an offline devfile registry with the following requirements:

  • Starter projects need to be packaged with as part of the build
  • Devfile needs to reference the offline starter projects during the build

Example:

starterProjects:
  - name: go-starter
+   zip: go-starter-offline.zip
-   git:
-     remotes:
-       origin: https://github.com/devfile-samples/devfile-stack-go.git
@openshift-ci openshift-ci bot added the area/registry Devfile registry for stacks and infrastructure label Jul 26, 2023
@mike-hoang mike-hoang self-assigned this Jul 26, 2023
@mike-hoang mike-hoang moved this to In Progress 🚧 in Devfile Project Jul 26, 2023
@mike-hoang
Copy link
Contributor Author

Initial approach

@mike-hoang
Copy link
Contributor Author

Updated approach

  • Use the registry-support build scripts to add all required files to the devfile-index instead of creating a new build script

@mike-hoang
Copy link
Contributor Author

Resources are now packaged as part of the devfile-index, next step is to create a way for the devfiles to reference the offline resources while also preserving location of the the original

@mike-hoang
Copy link
Contributor Author

Using the devfileEntriesFile, we can get a list of all the starter projects that can be made offline. The devfiles can also be overwritten with the location of the offline projects as well

@mike-hoang
Copy link
Contributor Author

Devfiles are now overwritten with the new starter project locations, while leaving the previous ones commented out. Will need to test a few more edge cases for overwriting along with ensuring temp files used for the devfile updating are cleaned

@mike-hoang
Copy link
Contributor Author

PRs opened for review:
devfile/registry-support#179 - adds the scripts required for offline build
devfile/registry#197 - entry point for creating the registry

@mike-hoang mike-hoang moved this from In Progress 🚧 to In Review 👀 in Devfile Project Aug 9, 2023
@mike-hoang mike-hoang changed the title Build and package offline registry Package starter projects in offline registry Aug 10, 2023
@thepetk thepetk moved this from In Review 👀 to Done ✅ in Devfile Project Aug 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/registry Devfile registry for stacks and infrastructure
Projects
Status: Done ✅
Development

Successfully merging a pull request may close this issue.

1 participant