generated from redhat-developer/new-project-template
-
Notifications
You must be signed in to change notification settings - Fork 55
RHIDP-8631: bulk import with gitlab #1474
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,23 @@ | ||
| :_mod-docs-content-type: ASSEMBLY | ||
|
|
||
| [id="bulk-importing-github-repositories"] | ||
| = Bulk importing GitHub repositories | ||
| = Bulk importing in {product} | ||
|
|
||
| include::{docdir}/artifacts/snip-technology-preview.adoc[] | ||
|
|
||
| {product} can automate GitHub repositories onboarding and track their import status. | ||
| {product} can automate the onboarding of GitHub repositories and GitLab projects, and track their import status. | ||
|
|
||
| include::modules/streamline-software-development-and-management/proc-enabling-and-authorizing-bulk-import-capabilities.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/streamline-software-development-and-management/proc-importing-multiple-repositories-from-github.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/importing-repositories/proc-importing-multiple-repositories-from-gitlab.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/streamline-software-development-and-management/proc-monitoring-bulk-import-actions-using-audit-logs.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/importing-repositories/concept-bulk-import-scaffolder-template.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/importing-repositories/procedure-integrating-bulk-import-with-orchestrator-workflows.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/importing-repositories/concept-data-handoff-and-custom-workflow-design.adoc[leveloffset=+1] | ||
| include::modules/importing-repositories/concept-data-handoff-and-custom-workflow-design.adoc[leveloffset=+1] | ||
|
|
37 changes: 37 additions & 0 deletions
37
...es/importing-repositories/proc-importing-multiple-repositories-from-gitlab.adoc
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| :_mod-docs-content-type: PROCEDURE | ||
|
|
||
| [id="importing-multiple-repositories-from-gitlab"] | ||
| = Importing multiple GitLab repositories | ||
|
|
||
| In {product}, you can select your GitLab projects and automate their onboarding to the {product-short} catalog. | ||
| This feature is a Technology preview. | ||
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| Technology Preview features provide early access to upcoming product innovations, enabling you to test functionality and provide feedback during the development process. | ||
| However, these features are not fully supported under Red Hat Subscription Level Agreements, may not be functionally complete, and are not intended for production use. | ||
| As Red Hat considers making future iterations of Technology Preview features generally available, we will attempt to resolve any issues that customers experience when using these features. | ||
| See: link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview support scope]. | ||
| ==== | ||
|
|
||
| .Prerequisites | ||
| * You have xref:enabling-and-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature and given access to it]. | ||
| * You have set up a link:https://docs.gitlab.com/user/profile/personal_access_tokens/[GitLab personal access token (PAT)]. | ||
|
|
||
| .Procedure | ||
| . In {product-very-short}, click *Bulk Import* | ||
| . Click *Import*. | ||
| . Select GitLab as your *Approval tool* option. | ||
| . Use the *Project* and *Group* views to see the list of all available GitLab projects and groups: | ||
| ** Use the *Project* view to select GitLab projects for importing. | ||
| ** Use the *Group* view to select GitLab groups and their associated projects for importing. | ||
| . In GitLab, review the automatically created "Ad `catalog-info.yaml` file" merge request for each project you selected for Bulk Import. | ||
| . Merge the merge request. | ||
|
|
||
| .Verification | ||
| //the name of the list is from luke's upstream video. | ||
| . In {product-very-short}, click *Bulk Import* | ||
| . In the *Imported entities* list, each imported GitLab project has the appropriate status: either _Waiting for approval_ or _Added_. | ||
| * For each _Waiting for approval_ import job listed, there is a corresponding merge request adding the `catalog-info.yaml` file in the corresponding project. | ||
|
|
||
|
|
||
This file contains hidden or 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
This file contains hidden or 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
28 changes: 14 additions & 14 deletions
28
...t-and-management/proc-managing-repositories-after-import-to-stay-organized.adoc
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,32 @@ | ||
| :_mod-docs-content-type: PROCEDURE | ||
|
|
||
| [id="managing-repositories-after-import-to-stay-organized"] | ||
| = Managing repositories after import to stay organized | ||
| [id="managing-the-added-repositories"] | ||
| = Managing the added Git repositories | ||
|
|
||
| You can oversee and manage the repositories that are imported to the {product-short}. | ||
| You can oversee and manage the Git repositories that are imported to the {product-short}. | ||
|
|
||
| .Prerequisites | ||
| * You have xref:proc-importing-multiple-repositories-from-github[imported GitHub repositories]. | ||
|
|
||
|
|
||
| .Procedure | ||
| . Click *Bulk Import* in the left sidebar to display all the current repositories that are being tracked as Import jobs, along with their status. | ||
| . Click *Bulk Import* in the left sidebar to display all the current GitHub repositories and GitLab projects that are being tracked as Import jobs, along with their status. | ||
|
|
||
| Added:: The repository is added to the {product-short} catalog after the import pull request is merged or if the repository already contained a `catalog-info.yaml` file during the bulk import. | ||
| Added:: The Git repository is added to the {product-short} catalog after the import pull request is merged or if the Git repository already contained a `catalog-info.yaml` file during the bulk import. | ||
| Note that it may take a few minutes for the entities to be available in the catalog. | ||
|
|
||
| Waiting for approval:: There is an open pull request adding a `catalog-info.yaml` file to the repository. | ||
| Waiting for approval:: There is an open pull request or merge request adding a `catalog-info.yaml` file to the GitHub repository or GitLab project. | ||
| You can: | ||
| * Click the *pencil icon* on the right to see details about the pull request or edit the pull request content right from {product-short}. | ||
| * Delete the Import job, this action closes the import PR as well. | ||
| * To transition the Import job to the _Added_ state, merge the import pull request from the Git repository. | ||
| * Click *pencil* icon on the right to see details about the pull request or merge request. You can use the detailed view to edit the request content right from {product-short}. | ||
| * Delete the Import job, this action closes the import pull request or merge request as well. | ||
| * To transition the Import job to the _Added_ state, merge the import pull request or merge request from the Git repository. | ||
|
|
||
| Empty:: {product-short} is unable to determine the import job status because the repository is imported from other sources but does not have a `catalog-info.yaml` file and lacks any import pull request adding it. | ||
| Empty:: {product-short} is unable to determine the import job status because the Git repository is imported from other sources but does not have a `catalog-info.yaml` file and lacks any import pull or merge request adding it. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| * After an import pull request is merged, the import status is marked as _Added_ in the list of Added Repositories, but it might take a few seconds for the corresponding entities to appear in the {product-short} Catalog. | ||
| * A location added through other sources (like statically in an `{my-app-config-file}` file, dynamically when {integrating-with-github-book-link}#enabling-github-repository-discovery[enabling GitHub discovery], or registered manually using the "Register an existing component" page) might show up in the Bulk Import list of Added Repositories if the following conditions are met: | ||
| ** The target repository is accessible from the configured GitHub integrations. | ||
| ** The location URL points to a `catalog-info.yaml` file at the root of the repository default branch. | ||
| * After an import pull request or merge request is merged, the import status is marked as _Added_ in the list of *Added entities*, but it might take a few seconds for the corresponding entities to appear in the {product-short} Catalog. | ||
| * A location added through other sources (for example, statically in an `{my-app-config-file}` file, dynamically when {integrating-with-github-book-link}#enabling-github-repository-discovery[enabling GitHub discovery], or registered manually using the "Register an existing component" page) might show up in the Bulk Import list of Added Repositories if the following conditions are met: | ||
| ** The location URL points to a `catalog-info.yaml` file at the root of the Git repository default branch. | ||
| ** For GitHub only: The target repository is accessible from the configured GitHub integrations. | ||
| ==== |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.