FLPATH-1555: Repo requirements for MTA workflow #354
Conversation
|
Why is a repository considered a requirement? I find this confusing. |
The main idea is to give the user a guideline on what type of git repo should be created when testing the MTA workflow. |
@rgolangh It helps to understand how to use MTA and to reduce the cognitive complexity for the user. In addition, this item FLPATH-1555 has been open by our QE team. FYI @y-first |
mta-v7.x/README.md
Outdated
| # Requirement for Repository | ||
| - Create a git repo with a simple Java class. It can either be public or private. | ||
| Currently, MTA supports mostly Java projects. | ||
| - If repository is private, refer to [configuring repository][4] on how to set up credentials on MTA. | ||
| - Note: When creating the source control credentials in MTA, ensure to input personal access token in the password field. | ||
| Refer to [personal access token] [5] on how to create personal access token (classic) on GitHub. | ||
| - Also, git url address must use https. Refer to [about remote repositories][6] for more details. | ||
| - If the repo is public, no further configuration is needed. | ||
|
|
There was a problem hiding this comment.
Instead of copy & paste this paragraph in multiple README, can we consider adding the paragraph here and then only add a link in each mta-v* README? Or maybe it's not a good place?
User's done need to create a repo, they need to analyze it. they should already have it. If this is for QE documentation then this is a bit of a different thing - the documentation addition here is addressing a different persona, and not the end user. |
|
A repo that is private will not work if the MTA admin didn't set the credentials for it. It is worth to link to the Konveyor tackle(the mta upstream) docs and MTA docs |
jenniferubah
force-pushed
the
FLPATH-1555
branch
from
cb0a886 to
b6c90f9
Compare
|
I suggest moving the new requirement into a "Testing" section where the user can provide an existing repository (an example can be provided, e.g. https://github.com/spring-projects/spring-petclinic) or create a new one based on the requirements listed in this PR. |
Listed out all the potential git repo requirements for MTA workflow and added it to all the docs for various MTA versions.