CASMPET-7058

.github/pull_request_template.md

@@ -0,0 +1,50 @@
+## Summary and Scope
+
+_Summarize what has changed. Explain why this PR is necessary. What is impacted? Is this a new feature, critical bug fix, etc?_
+
+_Is this change backwards incompatible, backwards compatible, or a backwards compatible bugfix?_
+
+## Issues and Related PRs
+
+_List and characterize relationship to Jira/Github issues and other pull requests. Be sure to list dependencies._
+
+* Resolves [issue id](issue link)
+* Change will also be needed in `<insert branch name here>`
+* Future work required by [issue id](issue link)
+* Documentation changes required in [issue id](issue link)
+* Merge with/before/after `<insert PR URL here>`
+
+## Testing
+
+_List the environments in which these changes were tested._
+
+### Tested on:
+
+  * `<development system>`
+  * Local development environment
+  * Virtual Shasta
+
+### Test description:
+
+_How were the changes tested and success verified? If schema changes were part of this change, how were those handled in your upgrade/downgrade testing?_
+
+- Were the install/upgrade-based validation checks/tests run (goss tests/install-validation doc)?
+- Were continuous integration tests run? If not, why?
+- Was upgrade tested? If not, why?
+- Was downgrade tested? If not, why?
+- Were new tests (or test issues/Jiras) created for this change?
+
+## Risks and Mitigations
+
+_Are there known issues with these changes? Any other special considerations?_
+
+
+## Pull Request Checklist
+
+- [ ] Version number(s) incremented, if applicable
+- [ ] Copyrights updated
+- [ ] License file intact
+- [ ] Target branch correct
+- [ ] Testing is appropriate and complete, if applicable
+- [ ] [HPC Product Announcement](https://cray.slack.com/archives/C026TVCSXLH) prepared, if applicable
+

CONTRIBUTING.md

@@ -3,16 +3,17 @@
 Welcome! This guide will help you understand how the CSM repository is
 organized and how to update components included in a CSM release distribution.
 
-- [Getting Started](#getting-started)
-- [PIT and NCN Image Assets](#pit-and-ncn-image-assets)
-- [RPM Repository Indexes](#rpm-repository-indexes)
-  - [RPM Index Format](#rpm-index-format)
-- [Loftsman Manifests and Docker and Helm Indexes](#loftsman-manifests-and-docker-and-helm-indexes)
-  - [Docker Index Format](#docker-index-format)
-  - [Helm Index Format](#helm-index-format)
-- [Vendored Repositories](#vendored-repositories)
-- [Git Workflow](#git-workflow)
-  - [Version Tags](#version-tags)
+- [Contributing to CSM](#contributing-to-csm)
+  - [Getting Started](#getting-started)
+  - [PIT and NCN Image Assets](#pit-and-ncn-image-assets)
+  - [RPM Repository Indexes](#rpm-repository-indexes)
+    - [RPM Index Format](#rpm-index-format)
+  - [Loftsman Manifests and Docker and Helm Indexes](#loftsman-manifests-and-docker-and-helm-indexes)
+    - [Docker Index Format](#docker-index-format)
+    - [Helm Index Format](#helm-index-format)
+  - [Vendored Repositories](#vendored-repositories)
+  - [Git Workflow](#git-workflow)
+    - [Version Tags](#version-tags)
 
 
 ## Getting Started
@@ -248,15 +249,6 @@ A _good_ pull request will provide, as appropriate:
 - Details about how changes were tested and verified
 
 
-### CHANGELOG.md
-
-Please add a concise summary of the change(s) in a pull request to
-[CHANGELOG.md]. It should go at the top of the `## Unreleased` section, which
-is at the beginning of the file. Please wrap lines at 80 characters for
-readability. If the `## Unreleased` section is not present, add it before the
-first _version_ section.
-
-
 ### Version Tags
 
 Tags prefixed with `v` are used to indicate a commit corresponds to a specific

Jenkinsfile.github

@@ -2,7 +2,7 @@
  *
  *  MIT License
  *
- *  (C) Copyright 2022 Hewlett Packard Enterprise Development LP
+ *  (C) Copyright 2022-2024 Hewlett Packard Enterprise Development LP
  *
  *  Permission is hereby granted, free of charge, to any person obtaining a
  *  copy of this software and associated documentation files (the "Software"),
@@ -24,7 +24,7 @@
  *
  */
 @Library('csm-shared-library') _
-def credentialsId = 'artifactory-algol60'
+
 pipeline {
     agent {
         label "metal-gcp-builder"
@@ -37,16 +37,25 @@ pipeline {
         disableConcurrentBuilds()
     }
 
+    environment {
+        DOCS_CSM_BRANCH = "release/1.4"
+        CSM_VSHASTA_DEPLOY_ENVIRONMENT = "vex"
+        CSM_BASE_VERSION = ""
+        ARTIFACTORY = credentials('artifactory-algol60-readonly')
+    }
+
     stages {
         stage('Setup') {
             steps {
                 script {
+                    env.ARTIFACTORY_USER = env.ARTIFACTORY_USR
+                    env.ARTIFACTORY_TOKEN = env.ARTIFACTORY_PSW
                     sh """
                         command -v parallel >/dev/null 2>&1 || {
                             echo >&2 "error: parallel: command not found"
                             exit 1
                         }
-                        make build/.env
+                        ./get_base.sh
                     """
                 }
             }
@@ -56,31 +65,46 @@ pipeline {
             parallel {
                 stage('Assets') {
                     steps {
-                        withCredentials([usernamePassword(credentialsId: credentialsId, usernameVariable: 'ARTIFACTORY_USER', passwordVariable: 'ARTIFACTORY_TOKEN')]) {
-                            sh "./assets.sh"
-                        }
+                        sh """
+                            ./hack/verify-assets.sh
+                        """
                     }
                 }
 
                 stage("Charts and Images") {
                     steps {
-                        sh ". build/.env/bin/activate && make images -j8"
+                        sh """
+                            make -C build/images -j8
+                        """
                     }
                 }
 
                 stage('RPM Index') {
                     steps {
                         sh """
-                            ./hack/verify-rpm-index.sh \
-                                rpm/cray/csm/sle-15sp2/index.yaml \
-                                rpm/cray/csm/sle-15sp2-compute/index.yaml \
-                                rpm/cray/csm/sle-15sp3/index.yaml \
-                                rpm/cray/csm/sle-15sp3-compute/index.yaml \
-                                rpm/cray/csm/sle-15sp4/index.yaml \
-                                rpm/cray/csm/sle-15sp4-compute/index.yaml
+                            ./hack/verify-rpm-index.sh
+                            ./hack/embedded-repo.sh --validate
                         """
                     }
                 }
+
+                stage("API Documentation") {
+                    environment {
+                        GIT_AUTHOR_NAME = "Jenkins"
+                        GIT_AUTHOR_EMAIL = "[email protected]"
+                        GIT_COMMITTER_NAME = "Jenkins"
+                        GIT_COMMITTER_EMAIL = "[email protected]"
+                        EMAIL = "[email protected]"
+                    }
+                    steps {
+                        script {
+                            env.GITHUB_APP_INST_TOKEN = getGitHubToken(appId: "330087", installId: "37198173", credentialsId: "github-jenkins-auto-push-bot-key")
+                            sh """
+                                ./hack/gen-push-swagger-markdown.sh ${env.DOCS_CSM_BRANCH} ${env.TAG_NAME ? '--push --wait' : ''}
+                            """
+                        }
+                    }
+                }
             }
         }
 
@@ -97,9 +121,6 @@ pipeline {
                 stage('Init') {
                     steps{
                         script {
-                            // verify head of correlated to DOCS-CSM branch has been tagged (built)
-                            // need to explicitly provide name of correlated to DOCS-CSM branch
-                            sh "./verify-docs-csm-tag.sh main"
                             env.RELEASE_VERSION = sh(script: './version.sh', returnStdout: true).trim()
                             slackSend(channel: env.SLACK_CHANNEL_NOTIFY, color: "#439fe0", message: "<${env.BUILD_URL}|CSM ${env.RELEASE_VERSION}> - Build starting, see #${env.SLACK_CHANNEL_ALERTS} for details")
                             slackSend(channel: env.SLACK_CHANNEL_ALERTS, color: "#439fe0", message: "<${env.BUILD_URL}|CSM ${env.RELEASE_VERSION}> - Build starting")
@@ -115,14 +136,9 @@ pipeline {
                     steps {
                         script {
                             slackSend(channel: env.SLACK_CHANNEL_ALERTS, message: "<${env.BUILD_URL}|CSM ${env.RELEASE_VERSION}> - Running release.sh")
-                            withCredentials([usernamePassword(credentialsId: credentialsId, usernameVariable: 'ARTIFACTORY_USER', passwordVariable: 'ARTIFACTORY_TOKEN')]) {
-                                sh """
-                                    . build/.env/bin/activate
-                                    make clean
-                                    rm -fr dist
-                                    ./release.sh
-                                """
-                            }
+                            sh """
+                                ./release.sh
+                            """
                         }
                     }
                     post {
@@ -158,6 +174,10 @@ pipeline {
                                     {
                                     "pattern": "dist/*-snyk-results.xlsx",
                                     "target": "csm-releases/${RELEASE_NAME}/${RELEASE_MAJOR_MINOR}/"
+                                    },
+                                    {
+                                    "pattern": "dist/*-images.txt",
+                                    "target": "csm-releases/${RELEASE_NAME}/${RELEASE_MAJOR_MINOR}/"
                                     }
                                 ]
                             }""",
@@ -188,6 +208,15 @@ pipeline {
                         env.SNYK_RESULTS_SHEET = "${env.RELEASE_NAME}-${env.RELEASE_VERSION}-snyk-results.xlsx"
                         env.SNYK_RESULTS_SHEET_URL = "${env.RELEASE_BASEURL}/${env.SNYK_RESULTS_SHEET}"
                         slackSend(channel: env.SLACK_CHANNEL_NOTIFY, color: "good", message: "<${env.BUILD_URL}|CSM ${env.RELEASE_VERSION}> - :white_check_mark: Success!\n- Release distribution: <${env.RELEASE_URL}|${env.RELEASE_NAME}-${env.RELEASE_VERSION}.tar.gz>\n- Snyk results: <${env.SNYK_RESULTS_SHEET_URL}|${env.SNYK_RESULTS_SHEET}> (raw scan results: <${env.SNYK_RESULTS_URL}|${env.SNYK_RESULTS_FILENAME}>)")
+                        build(job: "Cray-HPE/csm-vshasta-deploy/main", wait: false, parameters: [
+                            string(name: "CSM_RELEASE", value: env.RELEASE_VERSION),
+                            string(name: "ENVIRONMENT", value: env.CSM_VSHASTA_DEPLOY_ENVIRONMENT),
+                            string(name: "ARTIFACT_VERSION", value: "4.1.0"),
+                            string(name: "SLACK_REPORT_CHANNEL", value: env.SLACK_CHANNEL_NOTIFY)
+                        ])
+                        build(job: "Cray-HPE/csm-release-internal-upload/main", wait: false, parameters: [
+                            string(name: "RELEASE_VERSION", value: "${env.RELEASE_VERSION}"),
+                        ])
                     }
                 }
                 failure {

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-(C) Copyright 2021-2022 Hewlett Packard Enterprise Development LP
+(C) Copyright 2021-2024 Hewlett Packard Enterprise Development LP
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"),