search

moderneinc / moderne-docs

Moderne SaaS documentation as Gitbook contents
https://docs.moderne.io
2 stars 2 forks source link

Add a doc page for mod git clone options #150

Closed mike-solomon closed 4 days ago

mike-solomon commented 1 week ago

With explanations of what each option is + examples.

Related: https://moderneinc.slack.com/archives/C01S4M53THT/p1731432906703609

mike-solomon commented 1 week ago

Here are the things that need to be documented.

Column name Required Description Examples
cloneurl true The URL of the repository that should be ingested. git@github.com:google/guava.git
branch false The branch of the above repository that should be ingested. main
changeset false If provided, this will check out the repository at this specific commit SHA. aa5f25ac0031
java false Configures the JDK to use. 17 or 17-tem or 17.0.6-tem
jvmopts false JVM options added to tools building LSTs. Must be configured before you can run the build command if non-standard VM options are required. -Xmx4G
mavenargs false Build arguments are added to the end of the Maven command line when building LSTs. -P fast
gradleargs false Build arguments that are added to the end of the Gradle command line when building LSTs. -Dmyprop=myvalue
mike-solomon commented 1 week ago

I think there's some work that needs to be done here upon looking into this more. It seems like we (Moderne) are using this as our repos.csv for ingestion: https://github.com/moderneinc/moderne-organizations-multitenant/blob/main/tenants/moderne/repos.csv

In that, we don't include any of these columns other than the cloneUrl and branch -- we also provide a bunch of optional orgs afterwards. We also are providing cloneUrl instead of the cloneurl we expect (and containsKey is case sensitive I thought) - so I don't even know how that's working 🤔

mike-solomon commented 4 days ago

Added this in this commit: https://github.com/moderneinc/moderne-docs/commit/085bf27bff7356f4d85169014bce6f15e41e31b0