Add Contentful link checker app deployment to CI pipeline (#290)

uoa-noel · Trombach · web-flow · commit 55f6eaee9e32 · 2022-06-01T11:53:23.000+12:00
* Add token references for CI build

* Add missing package

* Fix npm shrinkwrap issue

* Fix wrong org id

* Update readme

* Update documentation

* Add indentation and minor fixes to README

* FIx minor heading issue with readme

Co-authored-by: Lukas Trombach &lt;19306765+Trombach@users.noreply.github.com&gt;
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -9,6 +9,7 @@ pipeline {
         booleanParam(name: "FORCE_REDEPLOY_WEB", defaultValue: false, description: 'Force redeploy the web frontend even if there are no code changes.' )
         booleanParam(name: "FORCE_REDEPLOY_CG", defaultValue: false, description: 'Force redeploy the cer-graphql API even if there are no code changes.')
         booleanParam(name: "FORCE_REDEPLOY_SP", defaultValue: false, description: 'Force redeploy the search-proxy Lambda  even if there are no code changes.')
+        booleanParam(name: "FORCE_REDEPLOY_SLC", defaultValue: false, description: 'Force redeploy the subhub-link-checker Contentful App even if there are no code changes.')
     }
 
     agent {
@@ -108,7 +109,7 @@ pipeline {
             }
         }
 
-        stage('Build cer-graphql and search-proxy projects') {
+        stage('Build cer-graphql, subhub-link-checker and search-proxy projects') {
             stages {
                 stage('Build search-proxy') {
                     when {
@@ -139,6 +140,23 @@ pipeline {
                         }
                     }
                 }
+                stage('Build subhub-link-checker') {
+                    when {
+                        anyOf {
+                            changeset "**/subhub-link-checker/**/*.*"
+                            equals expected: true, actual: params.FORCE_REDEPLOY_SLC
+                        }
+                    }
+                    steps {
+                        echo 'Building subhub-link-checker project'
+                        dir("subhub-link-checker") {
+                            echo 'Installing subhub-link-checker dependencies...'
+                            sh "npm ci"
+                            sh "npm run build"
+                        }
+                    }
+                    
+                }
             }
         }
 
@@ -184,7 +202,7 @@ pipeline {
             }
         }
 
-        stage('Deploy cer-graphql and search-proxy projects') {
+        stage('Deploy cer-graphql, search-proxy and subhub-link-checker projects') {
             parallel {
                 stage('Deploy cer-graphql') {
                     when {
@@ -226,6 +244,27 @@ pipeline {
                         echo "Deploy to ${BRANCH_NAME} complete"
                     }
                 }
+                stage('Deploy subhub-link-checker') {
+                    when {
+                        anyOf {
+                            changeset "**/subhub-link-checker/**/*.*"
+                            equals expected: true, actual: params.FORCE_REDEPLOY_SLC
+                        }
+                    }
+                    steps {
+                        dir("subhub-link-checker") {
+                            // Grab relevant credentials
+                            withCredentials([
+                                string(credentialsId: "contentful-pat", variable: "contentfulPat"),
+                                string(credentialsId: "contentful-link-checker-app-id-${BRANCH_NAME}", variable: "contentfulSLCAppId"),
+                                string(credentialsId: "contentful-org-id", variable: "contentfulOrgId")
+                            ]) {
+                                sh "npm run upload-ci -- --organization-id ${contentfulOrgId} --definition-id ${contentfulSLCAppId} --token ${contentfulPat}"
+                            }
+                            
+                        }
+                    }
+                }
             }
         }
         
diff --git a/subhub-link-checker/README.md b/subhub-link-checker/README.md
@@ -14,11 +14,15 @@ Part of the Hub Expansion project. This is required due to SubHub routing logic
 There are three instances of the Contentful App - one for dev, test and prod. [Read more...](https://www.contentful.com/developers/docs/extensibility/app-framework/)
 
 ## Seeing and deploying your changes
+Build and deployment for the SubHub Link Checker app are part of the Jenkins CI process. 
+
+ResearchHub has three Contentful environments - `dev`, `test`, and `prod`, and `prod` is the one content authors see. An [app definition](https://www.contentful.com/developers/docs/extensibility/app-framework/app-definition/) is set up for in three different environments, which means different versions of the link checker app can run in each environment. Deploy changes to `dev` for previewing your changes and manual testing - Contentful Apps can't be run locally. Deployment to `test` and `prod` should only be done as part of [the official release process](https://wiki.auckland.ac.nz/display/APPLCTN/Release+to+prod) and content authors need to be notified before deploying updates.
+
 This assumes the Contentful environments are set up with the required app definitions. See the First time deployment section if you need to redo those steps.
 
-ResearchHub has three Contentful environments - `dev`, `test`, and `prod`, and `prod` is the one content authors see. Use `dev` for previewing your changes and manual testing - Contentful Apps can't be run locally. Deployment to `test` and `prod` should only be done as part of [the official release process](https://wiki.auckland.ac.nz/display/APPLCTN/Release+to+prod) and content authors need to be notified before deploying updates.
+## Manual deployment
+If you would like to manually deploy the App (for example, if you would like to preview changes in the dev Contentful environment without having to commit and push into your dev branch), follow these instructions.
 
-1. If you are deploying to `test` and `prod`, first check-in your changes to Git and merge them into `master`.
 1. Run `npm run build` to build a new bundle.
 2. Run `npm run upload`.
     1. For the bundle comment, put in the hash of Git commit you built the bundle from if applicable.
@@ -28,6 +32,7 @@ ResearchHub has three Contentful environments - `dev`, `test`, and `prod`, and `
 3. Go to Contentful to see your changes.
 
 ## First time deployment
+These instructions are for deploying to a fresh Contentful instance.
 
 1. Create three Apps on Contentful. In the `subhub-link-checker` folder, run the command:
 
@@ -59,6 +64,11 @@ ResearchHub has three Contentful environments - `dev`, `test`, and `prod`, and `
 
     Open a SubHub to verify the Internal Pages field is still editable. If it is, then the App setup is complete!
 
+4. Create a [Contentful personal access token](https://www.contentful.com/developers/docs/references/authentication/#getting-a-personal-access-token), preferably using a service account. Add these five secrets to Jenkins credentials store, so the Jenkins CI process can refer to the values. Read `Jenkinsfile` to see how these values are used. 
+    * Personal Access Token: `contentful-pat`
+    *  The App definition ID for each app definition: `contentful-link-checker-app-id-dev`, `contentful-link-checker-app-id-test`, and `contentful-link-checker-app-id-prod`.
+    * Organisation ID: `contentful-org-id`
+
 ## Development
 This project was bootstrapped with [Create Contentful App](https://github.com/contentful/create-contentful-app).
 
diff --git a/subhub-link-checker/package-lock.json b/subhub-link-checker/package-lock.json
diff --git a/subhub-link-checker/package.json b/subhub-link-checker/package.json
@@ -16,6 +16,7 @@
     "@types/node": "^16.0.2",
     "@types/react": "^17.0.14",
     "@types/react-dom": "^17.0.11",
+    "contentful-management": "^7.51.3",
     "cross-env": "^7.0.3",
     "gh-pages": "^3.1.0",
     "react": "^17.0.2",
@@ -29,7 +30,7 @@
     "test": "react-scripts test",
     "eject": "react-scripts eject",
     "upload": "contentful-app-scripts upload --bundle-dir ./build",
-    "upload-ci": "contentful-app-scripts upload --ci --bundle-dir ./build  --organization-id $CONTENTFUL_ORG_ID --definition-id $CONTENTFUL_APP_DEF_ID --token $CONTENTFUL_ACCESS_TOKEN"
+    "upload-ci": "contentful-app-scripts upload --ci --bundle-dir ./build"
   },
   "eslintConfig": {
     "extends": "react-app"

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ pipeline {`
`9`	`9`	`booleanParam(name: "FORCE_REDEPLOY_WEB", defaultValue: false, description: 'Force redeploy the web frontend even if there are no code changes.' )`
`10`	`10`	`booleanParam(name: "FORCE_REDEPLOY_CG", defaultValue: false, description: 'Force redeploy the cer-graphql API even if there are no code changes.')`
`11`	`11`	`booleanParam(name: "FORCE_REDEPLOY_SP", defaultValue: false, description: 'Force redeploy the search-proxy Lambda even if there are no code changes.')`
	`12`	`+ booleanParam(name: "FORCE_REDEPLOY_SLC", defaultValue: false, description: 'Force redeploy the subhub-link-checker Contentful App even if there are no code changes.')`
`12`	`13`	`}`
`13`	`14`
`14`	`15`	`agent {`
`@@ -108,7 +109,7 @@ pipeline {`
`108`	`109`	`}`
`109`	`110`	`}`
`110`	`111`
`111`		`- stage('Build cer-graphql and search-proxy projects') {`
	`112`	`+ stage('Build cer-graphql, subhub-link-checker and search-proxy projects') {`
`112`	`113`	`stages {`
`113`	`114`	`stage('Build search-proxy') {`
`114`	`115`	`when {`
`@@ -139,6 +140,23 @@ pipeline {`
`139`	`140`	`}`
`140`	`141`	`}`
`141`	`142`	`}`
	`143`	`+ stage('Build subhub-link-checker') {`
	`144`	`+ when {`
	`145`	`+ anyOf {`
	`146`	`+ changeset "/subhub-link-checker//."`
	`147`	`+ equals expected: true, actual: params.FORCE_REDEPLOY_SLC`
	`148`	`+ }`
	`149`	`+ }`
	`150`	`+ steps {`
	`151`	`+ echo 'Building subhub-link-checker project'`
	`152`	`+ dir("subhub-link-checker") {`
	`153`	`+ echo 'Installing subhub-link-checker dependencies...'`
	`154`	`+ sh "npm ci"`
	`155`	`+ sh "npm run build"`
	`156`	`+ }`
	`157`	`+ }`
	`158`	`+`
	`159`	`+ }`
`142`	`160`	`}`
`143`	`161`	`}`
`144`	`162`
`@@ -184,7 +202,7 @@ pipeline {`
`184`	`202`	`}`
`185`	`203`	`}`
`186`	`204`
`187`		`- stage('Deploy cer-graphql and search-proxy projects') {`
	`205`	`+ stage('Deploy cer-graphql, search-proxy and subhub-link-checker projects') {`
`188`	`206`	`parallel {`
`189`	`207`	`stage('Deploy cer-graphql') {`
`190`	`208`	`when {`
`@@ -226,6 +244,27 @@ pipeline {`
`226`	`244`	`echo "Deploy to ${BRANCH_NAME} complete"`
`227`	`245`	`}`
`228`	`246`	`}`
	`247`	`+ stage('Deploy subhub-link-checker') {`
	`248`	`+ when {`
	`249`	`+ anyOf {`
	`250`	`+ changeset "/subhub-link-checker//."`
	`251`	`+ equals expected: true, actual: params.FORCE_REDEPLOY_SLC`
	`252`	`+ }`
	`253`	`+ }`
	`254`	`+ steps {`
	`255`	`+ dir("subhub-link-checker") {`
	`256`	`+ // Grab relevant credentials`
	`257`	`+ withCredentials([`
	`258`	`+ string(credentialsId: "contentful-pat", variable: "contentfulPat"),`
	`259`	`+ string(credentialsId: "contentful-link-checker-app-id-${BRANCH_NAME}", variable: "contentfulSLCAppId"),`
	`260`	`+ string(credentialsId: "contentful-org-id", variable: "contentfulOrgId")`
	`261`	`+ ]) {`
	`262`	`+ sh "npm run upload-ci -- --organization-id ${contentfulOrgId} --definition-id ${contentfulSLCAppId} --token ${contentfulPat}"`
	`263`	`+ }`
	`264`	`+`
	`265`	`+ }`
	`266`	`+ }`
	`267`	`+ }`
`229`	`268`	`}`
`230`	`269`	`}`
`231`	`270`