Improve downstream projects to more easily specify their project-specific Helm publishing repository

[chang-annie]

Currently for aiSSEMBLE downstream projects, there is no defined default helm chart publishing repository. In order to make project generation as smooth as possible, we should add the functionality to specify the helm publishing repository during project creation.

Definition of Done

• Update archetype to allow specification of project-specific Helm publishing repository
• Ensure that project-specific Helm repository is enabled for project-specific modules
• Update documentation to highlight how to specify a project-specific Helm repository
• Update release notes to manually add a private Helm repository for projects migrating from a prior version of aissemble

Test Steps

• Make sure your dev branch is up-to-date and build the project using mvn clean install
• Run the archetype plugin with the following commands:

cd ..

mvn archetype:generate \
    -DarchetypeGroupId=com.boozallen.aissemble \
    -DarchetypeArtifactId=foundation-archetype \
    -DarchetypeVersion=1.7.0-SNAPSHOT \
    -DgroupId=com.boozallen.test \
    -DartifactId=issue-84 \
    -DprojectGitUrl=url \
    -DprojectName=issue-84 \
    -DhelmPublishingRepositoryUrl=https://helm-publish-base-url/repository \
    -DhelmPublishingRepositoryName=my-helm-charts

cd ./issue-84

• Run the following command to validate that the Helm publishing repository was configured into the project's helm-maven-plugin's helmPublishingRepositoryUrl variable:

% cat pom.xml | grep helm-publish-base-url  

• Validate the response is:

 <helm.publishing.repository.url>https://helm-publish-base-url/repository</helm.publishing.repository.url>

• Run the following command to validate that the Helm publishing repository name was configured into the project's helm-maven-plugin's helmPublishingRepositoryName variable:

% cat pom.xml | grep my-helm-charts 

• Validate the response is:

 <helm.publishing.repository.name>my-helm-charts</helm.publishing.repository.name>

• Validate the following sections of your project's issue-84-deploy/pom.xml file
  • the helm-maven-plugin has a new push execution goal

  <plugin>
      <groupId>${group.helm.plugin}</groupId>
      <artifactId>helm-maven-plugin</artifactId>
      <executions>
         ...
          <execution>
              <id>deploy</id>
              <phase>deploy</phase>
              <goals>
                  <goal>push</goal>
              </goals>
          </execution>
      </executions>
  

  • the helm-maven-plugin has uploadRepoStable and uploadRepoSnapshot configurations that include both the helm.publishing.repository.name and helm.publishing.repository.url properties

  <configuration>
    ...
      <uploadRepoStable>
          <name>${helm.publishing.repository.name}</name>
          <url>${helm.publishing.repository.url}</url>
      </uploadRepoStable>
      <uploadRepoSnapshot>
          <name>${helm.publishing.repository.name}</name>
          <url>${helm.publishing.repository.url}</url>
      </uploadRepoSnapshot>
     ...
  </configuration>
  
  

• Navigate to the aissemble docs Creating a Project page
• Validate that instructions for helmPublishingRepositoryUrl and helmPublishingRepositoryName exist and also point to the helm-maven-plugin documentation for more information about other configuration options
• Validate that the release notes for 1.7.0 have instructions to manually update Helm chart repositories for publishing

[chang-annie]

tested and confirmed by @jacksondelametter