Merge pull request #68 from boozallen/65-project-specific-pypi-repo

#65 ✨ add innate support for downstream projects using a dif…

Author: d-ryan-ashcraft

DRAFT_RELEASE_NOTES.md

@@ -64,6 +64,8 @@ The [Maven Build Cache](https://maven.apache.org/extensions/maven-build-cache-ex
 Note instructions for adapting to these changes are outlined in the upgrade instructions below.  
 * The maven property `version.clean.plugin` was changed to `version.maven.clean.plugin` causing the `*-deploy/pom.xml` 
   to be invalid
+* If you were using a private PyPI repository in a prior release, the upgrade instructions below contain a small change
+  that must be made to continue using that repository.
 
 ## DataLineage and ModelLineage Event Changes
 To associate the pipeline step's lineage event with the pipeline's, we have created a pipeline level lineage event, and a way
@@ -167,6 +169,36 @@ for publishing and retrieving releases and snapshots. Adjust for your project as
 </properties>
 ```
 
+### Update Habushu to Point to Your Private PyPI Repository
+Add the following `property` and `plugin` into your project's root `pom.xml` file with the appropriate PyPI repository URL (Nexus is used
+in this example - adjust for your project, as appropriate):
+```xml
+  <properties>
+    ...
+    <pypi.project.repository.url>https://nexus.yourdomain/repository/your-pypi-repo-name/</pypi.project.repository.url>
+  </properties>
+  ...
+  <build>
+    <pluginManagement>
+      <plugins>
+        ...  
+        <plugin>
+          <groupId>org.technologybrewery.habushu</groupId>
+          <artifactId>habushu-maven-plugin</artifactId>
+          <configuration>
+            <!--
+              Ensure you have configured credentials for this repo, as explained in the following link:
+              https://github.com/TechnologyBrewery/habushu?tab=readme-ov-file#pypirepoid
+            -->
+            <pypiRepoUrl>${pypi.project.repository.url}</pypiRepoUrl>
+          </configuration>
+        </plugin>
+      </plugins>  
+    </pluginManagement>
+  </build>
+
+```
+
 ## Conditional Steps
 
 ### Upgrade Steps for Projects Leveraging Data Lineage

docs/modules/ROOT/pages/archetype.adoc

@@ -36,22 +36,25 @@ mvn archetype:generate \
 --
 endif::[]
 
-This command will trigger an interactive questionnaire giving you the opportunity to enter the following information contained in the below table.
+This command will trigger an interactive questionnaire giving you the opportunity to enter the following information
+contained in the below table.
 
 *  This information can also be provided without interaction by including ``-D<propertyName>=<propertyValue>`` for each
 property you want to manually set when running the ``mvn archetype:generate`` command.
 * Some of the information required (such as ``archetypeVersion``) is unavailable in interactive mode. For these
 properties, you can use the above Maven command to include them.
 
 .Archetype Options
-[cols="1a,2a,3a,2a,5a"]
+[cols="2a,3a,3a,2a,1a"]
 |===
 | Value | Description | Guidance | Example(s) | Interactive
 
 | ``archetypeVersion``
 | Use an archetype from a specific aiSSEMBLE release
 |
-Typically, developers should target the most recently released archetype. In appropriate circumstances, it is possible to target a pre-release https://maven.apache.org/guides/getting-started/index.html#what-is-a-snapshot-version[snapshot version,role=external,window=_blank] by using the -SNAPSHOT suffix.
+Typically, developers should target the most recently released archetype. In appropriate circumstances, it is possible
+to target a pre-release https://maven.apache.org/guides/getting-started/index.html#what-is-a-snapshot-version[snapshot
+version,role=external,window=_blank] by using the -SNAPSHOT suffix.
 
 |
 * 0.11.0
@@ -157,6 +160,27 @@ easily and automatically follow this Snapshot pattern as well (where ``-SNAPSHOT
 
 | No
 
+| `pypiProjectRepositoryUrl`
+| The name of the custom PyPI repository to use for this project.
+| Should be used if you have Python modules and intend to publish your project's PyPI artifacts to a private repository,
+such as Nexus or Artifactory.  If you plan to use the public https://pypi.org repository, you can explicitly set that
+here as well.
+
+Please see https://github.com/TechnologyBrewery/habushu?tab=readme-ov-file#pypirepoid[Habushu's documentation on
+repository URLs,role=external,window=_blank], including how to leverage `settings.xml` to pass in credentials
+for these repositories. These instructions also cover URL configuration for specific PyPI repository types (e.g.,
+upload and download url specialization) as well as how to also configure a separate release and development PyPI URL,
+if desired.
+
+If not specified, this will default to `https://pypi-PLACEHOLDER/repository/` and will need to be updated in your root
+`pom.xml` file prior to pushing your first PyPI artifacts to a repository.
+|
+* `https://nexus.mydomain.com/repository/x-pypi`
+* `https://artifactory.mydomain.com/repository/y-pypi`
+* `https://pypi.org`
+
+| No
+
 |===
 
 Once you enter these values, the archetype will ask you to confirm your entries. You now have a Maven project in which 

foundation/foundation-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml

@@ -42,6 +42,9 @@
 		<requiredProperty key="mavenSnapshotRepositoryUrl">
 			<defaultValue>https://snapshot-PLACEHOLDER/repository/maven-snapshots</defaultValue>
 		</requiredProperty>
+		<requiredProperty key="pypiProjectRepositoryUrl">
+			<defaultValue>https://pypi-PLACEHOLDER/repository/</defaultValue>
+		</requiredProperty>
 	</requiredProperties>
 
 	<fileSets>

foundation/foundation-archetype/src/main/resources/archetype-resources/pom.xml

@@ -40,6 +40,7 @@
         <maven.repo.url>${mavenRepositoryUrl}</maven.repo.url>
         <maven.snapshot.repo.id>maven-snapshots</maven.snapshot.repo.id>
         <maven.snapshot.repo.url>${mavenSnapshotRepositoryUrl}</maven.snapshot.repo.url>
+        <pypi.project.repository.url>${pypiProjectRepositoryUrl}</pypi.project.repository.url>
     </properties>
 
     <dependencyManagement>