@madgex/fert 5.0.3 → 5.0.4

package/README.md

@@ -198,7 +198,7 @@ Templates & CSS may be processed using the [CSS Modules](https://github.com/css-
 ## Publish
 
 From root, run for all services or a specific service:
-`fert publish --target=prod` | `fert publish --target=prod --service-name=jobseekers-frontend`
+`fert publish --target=production` | `fert publish --target=production --service-name=jobseekers-frontend`
 
 Run for 1 service from the service folder:
 `cd services/jobseekers-frontend`
@@ -208,10 +208,10 @@ Run for 1 service from the service folder:
 
 `fert publish  --target [target]`
 
-| Option      |                                                                              |
-| ----------- | ---------------------------------------------------------------------------- |
-| `--target`  | Where to publish the `dist` directory assets.<br/>`dev` \| `prod` (`string`) |
-| `--dry-run` | Dry run, dont actually upload anything                                       |
+| Option      |                                                                                    |
+| ----------- | ---------------------------------------------------------------------------------- |
+| `--target`  | Where to publish the `dist` directory assets.<br/>`dev` \| `production` (`string`) |
+| `--dry-run` | Dry run, dont actually upload anything                                             |
 
 Send all files and directories created in the `dist` directory to either development or production versions of the Asset Store API. Files uploaded to the Asset Store API are available via a CloudFront-based CDN.
 
@@ -316,7 +316,19 @@ These options are available no matter the command used.
 
 # CI/CD
 
-It's intended that the branding repos have their own build/deploy pipeline. Each change that's merged to `master` will trigger a build (`npm run build` as a common entry point) and the resulting output directory (`dist`) is pushed up to the `asset-store-api` for use in production.
+All branding repos use a common jekinsfile and Dockerfile to build/deploy, and will use this FERT tool.
+
+- Here is the jenkinsfile all branding repos use: https://github.com/wiley/madgex-jenkins-shared-library/blob/master/vars/clientRepoDeploymentPipeline.groovy .
+- And the Dockerfile they all use [is in this repo](shared/Dockerfile.brandingRepoPublish).
+
+Each change that's pushed to a branch will trigger:
+
+1. a build (`npm run build` inside the [Dockerfile](shared/Dockerfile.brandingRepoPublish) as a common entry point), which creates a `dist` folder full of assets ready to upload.
+2. The [jenkinsfile](https://github.com/wiley/madgex-jenkins-shared-library/blob/master/vars/clientRepoDeploymentPipeline.groovy) pipeline will run `fert publish` to send all built assets to the Asset Store API.
+3. The [jenkinsfile](https://github.com/wiley/madgex-jenkins-shared-library/blob/master/vars/clientRepoDeploymentPipeline.groovy) pipeline will run `fert configs --publish`, Uploading the branding repo's client `/configs` to the configuration-api.
+
+> [!NOTE]
+> `master` branch will go to `production`. All other branches will go to `jb dev`.
 
 ## `npm scripts`
 
@@ -330,5 +342,3 @@ Here are the default npm scripts in a Fert-scaffolded project.
   }
 }
 ```
-
-Its expected that a Jenkins pipeline will run `fert publish` to send all built assets to the Asset Store API.

package/bin/cli.js

@@ -37,7 +37,10 @@ const run = () => {
 
   cli
     .command('publish', 'Publish the project')
-    .option('--target <env>', 'Environment to publish to, "dev" or "prod"')
+    .option(
+      '--target <env>',
+      'Environment to publish to, "dev" or "production"'
+    )
     .option('--service-name <serviceName>', '[string] run a single service')
     .option('--dry-run', 'Dry run, dont actually upload anything')
     .action((...args) => serivceCommandBootstrap('publish', ...args));

package/bin/commands/_service-command-bootstrap.js

@@ -3,10 +3,7 @@ const chalk = require('chalk');
 const {
   loadServiceConfigFiles,
   loadConfigFromFile,
-  findFertConfigDir,
 } = require('../utils/index.js');
-const { getConfigAPI, validateLocalConfigs } = require('../utils/configs.js');
-const { handlePublish } = require('../commands/configs.js');
 
 const commandDevSever = require('./dev-server.js');
 const commandBuild = require('./build.js');
@@ -67,48 +64,18 @@ module.exports.serivceCommandBootstrap = async function serivceCommandBootstrap(
   console.log(
     `🔦 ${chalk.green('Running multi service mode')}, calling ${chalk.cyan(command)} on ${chalk.cyan(serviceConfigs.length)} ${serviceConfigs.length === 1 ? 'service' : 'services'} [${serviceConfigs.map((i) => chalk.cyanBright(i?.serviceConfig?.serviceName || 'Unknown')).join(', ')}]`
   );
-  try {
-    for (const { serviceConfig } of serviceConfigs) {
-      try {
-        await commandMap[command]({
-          ...options,
-          serviceName: serviceConfig.serviceName,
-        });
-      } catch (err) {
-        throw new Error(
-          `Failed to run command ${command} on service ${serviceConfig.serviceName}: ${err.message}`,
-          { cause: err }
-        );
-      }
-    }
 
-    // if we're publishing, update all configs on configuration API
-    if (command === 'publish') {
-      options.target = options.target === 'dev' ? 'dev' : 'production';
-      const rootDir = await findFertConfigDir();
-      const { clientPropertyId } = await loadConfigFromFile({ dir: rootDir });
-      const api = await getConfigAPI({
-        clientPropertyId,
-        environment: options.target,
+  for (const { serviceConfig } of serviceConfigs) {
+    try {
+      await commandMap[command]({
+        ...options,
+        serviceName: serviceConfig.serviceName,
       });
-
-      // validate & upload local configs to configuration API
-      if (!options.dryRun) {
-        await handlePublish({ clientPropertyId, workingDir: rootDir }, api, {
-          publish: options.target,
-        });
-      } else {
-        await validateLocalConfigs({
-          clientPropertyId,
-          workingDir: rootDir,
-          throwable: true,
-        });
-      }
-
-      log.success(`${chalk.green('Publish completed successfully')}`);
+    } catch (err) {
+      throw new Error(
+        `Failed to run command ${command} on service ${serviceConfig.serviceName}: ${err.message}`,
+        { cause: err }
+      );
     }
-  } catch (error) {
-    log.error('Failed to run command', command, options);
-    console.error(error);
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@madgex/fert",
-  "version": "5.0.3",
+  "version": "5.0.4",
   "description": "Tool to help build the V6 branding",
   "bin": {
     "fert": "./bin/cli.js"

package/delivery/jenkinsfile

@@ -1,93 +0,0 @@
-#!/usr/bin/env groovy
-library 'jenkins-shared-library'
-
-def productName     =   'rollout-tool'   // the name of the product to which this service belongs (jobboard/insights/employerbranding/core-services)
-
-def (subProductName, branchName)    =   "${env.JOB_NAME}".tokenize( '/' )
-def siteName                        =   "$productName/$subProductName"
-def repositoryUri                   =   "426517516965.dkr.ecr.eu-west-1.amazonaws.com"
-
-pipeline {
-    agent {
-        any {
-            customWorkspace "workspace/${env.JOB_NAME}/${branchName}".replace('%2F', '-')
-        }
-    }
-
-    options {
-        timeout(time: 1, unit: 'HOURS')
-        disableConcurrentBuilds()
-        skipStagesAfterUnstable()
-        skipDefaultCheckout()
-        buildDiscarder(logRotator(daysToKeepStr: '10', numToKeepStr: '3'))
-    }
-
-    environment {
-        NPM_TOKEN = credentials('MDS_NPM_TOKEN')
-        AWS_CREDENTIALS_ID = "${params.ENVIRONMENTS == 'jb.dev' ? 'rollout-tool-consumer-key-parameter-store-jb-dev' : 'rollout-tool-consumer-key-parameter-store-production'}"
-    }
-
-    stages {
-        stage('SCM') {
-            steps {
-                notifySlack('STARTED', 'fed-services-builds', 'jenkins-slack-token')
-                checkout scm
-                notifyBitbucketWithState('INPROGRESS')
-            }
-        }
-
-        stage('Build') {
-            steps {
-                script {
-                    withCredentials([
-                        usernamePassword(credentialsId: 'github-lerna-write', passwordVariable: 'GIT_PASSWORD', usernameVariable: 'GIT_USERNAME'),
-                        [$class: 'AmazonWebServicesCredentialsBinding', credentialsId: "${env.AWS_CREDENTIALS_ID}"]
-                      ]){
-
-                        docker.build("madgex/front-end-rollout-tool", "--no-cache --build-arg NPM_TOKEN=$env.NPM_TOKEN --build-arg GIT_USERNAME=$GIT_USERNAME --build-arg GIT_PASSWORD=$GIT_PASSWORD .")
-
-                        sh """
-                            docker run --rm -e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY madgex/front-end-rollout-tool:latest npm run publish -- --environment=${params.ENVIRONMENTS} --clientPropertyId=${params.CLIENT_PROPERTY_ID}
-
-                        """
-                      }
-                }
-            }
-        }
-        stage('Call branding service') {
-            steps {
-                script {
-                    build job: 'madgex-branding-service', parameters: [
-                        string(name: 'CLIENT_PROPERTY_ID', value: params.CLIENT_PROPERTY_ID),
-                        string(name: 'DESIGN_SYSTEM_VERSION', value: params.DESIGN_SYSTEM_VERSION),
-                        string(name: 'ENVIRONMENTS', value: params.ENVIRONMENTS),
-                    ]
-                } 
-            }
-        }
-
-    }
-
-    post {
-        failure {
-            script {
-                notifyBitbucketWithState('FAILURE')
-                // This channel is only for failures
-                notifySlack(currentBuild.result, 'pipeline-alerts-fed', 'jenkins-slack-token')
-            }
-        }
-        success {
-            script {
-                notifyBitbucketWithState('SUCCESS')
-            }
-        }
-        always { 
-            script {
-                // Necessary to get emailer to send out on success
-                currentBuild.result = currentBuild.currentResult
-            }
-            notifySlack(currentBuild.result, 'fed-services-builds', 'jenkins-slack-token')
-            cleanWs deleteDirs: true
-        }
-    }    
-}