@cmflow/cli 0.65.1

package/src/semantic-release/get-semantic-config.js

@@ -0,0 +1,115 @@
+import { getConfig } from '../common/get-config'
+import { WORKFLOW_CONFIGURATION } from '../workflow'
+
+const releaseRules = WORKFLOW_CONFIGURATION.map(({ label, ...props }) => props)
+const commitTypeMapping = WORKFLOW_CONFIGURATION.reduce((obj, { type, label }) => {
+  return {
+    ...obj,
+    [type]: label
+  }
+}, {})
+
+const transformCommitType = commit => {
+  if (commitTypeMapping[commit.type]) {
+    return commitTypeMapping[commit.type]
+  }
+
+  return commitTypeMapping.default
+}
+
+const transform = (commit, context) => {
+  const issues = []
+
+  commit.notes.forEach(note => {
+    note.title = 'BREAKING CHANGES'
+  })
+
+  commit.type = transformCommitType(commit)
+
+  if (commit.message && commit.message.match(/^[\w-]+$/i)) {
+    return
+  }
+
+  if (commit.subject) {
+    commit.subject = commit.subject.replace('[MEP]', '')
+  }
+
+  if (commit.scope === '*') {
+    commit.scope = ''
+  }
+
+  if (typeof commit.hash === 'string') {
+    commit.shortHash = commit.hash.substring(0, 7)
+  }
+
+  if (typeof commit.subject === 'string') {
+    let url = context.repository
+      ? `${context.host}/${context.owner}/${context.repository}`
+      : context.repoUrl
+    if (url) {
+      url = `${url}/issues/`
+      // Issue URLs.
+      commit.subject = commit.subject.replace(/#([0-9]+)/g, (_, issue) => {
+        issues.push(issue)
+        return `[#${issue}](${url}${issue})`
+      })
+    }
+    if (context.host) {
+      // User URLs.
+      commit.subject = commit.subject.replace(
+        /\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g,
+        (_, username) => {
+          if (username.includes('/')) {
+            return `@${username}`
+          }
+
+          return `[@${username}](${context.host}/${username})`
+        }
+      )
+    }
+  }
+
+  // remove references that already appear in the subject
+  commit.references = commit.references.filter(reference => {
+    if (issues.indexOf(reference.issue) === -1) {
+      return true
+    }
+
+    return false
+  })
+
+  return commit
+}
+
+export function getSemanticConfig () {
+  const config = getConfig()
+
+  return {
+    noCi: config.PRODUCTION_BRANCH !== config.BRANCH_NAME,
+    branches: [
+      {
+        name: config.PRODUCTION_BRANCH,
+        channel: 'release'
+      },
+      // Use this hack to always run semantic-release (as prerelease for feature/fix branch)
+      {
+        name: config.BRANCH_NAME,
+        channel: 'prerelease',
+        prerelease: true
+      }
+    ],
+    verifyConditions: ['@cmflow/cli/semantic'],
+    analyzeCommits: ['@cmflow/cli/semantic'],
+    verifyRelease: ['@cmflow/cli/semantic'],
+    generateNotes: ['@cmflow/cli/semantic'],
+    prepare: ['@cmflow/cli/semantic'],
+    publish: ['@cmflow/cli/semantic'],
+    success: ['@cmflow/cli/semantic'],
+    fail: ['@cmflow/cli/semantic'],
+    releaseRules,
+    parserOpts: {
+      noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES']
+    },
+    writerOpts: { transform }
+  }
+}

package/src/semantic-release/utils/calculate-snapshot-version.js

@@ -0,0 +1,9 @@
+import semver from 'semver'
+import { git } from '../../common'
+
+export function calculateSnapshotVersion (context) {
+  const { nextRelease: { type }, lastRelease, config: { REF_COMMIT } } = context
+  const { major, minor, patch } = semver.parse(lastRelease.version)
+
+  return `${semver.inc(`${major}.${minor}.${patch}`, type)}-beta${git.getCommitTag(REF_COMMIT)}`
+}

package/src/semantic-release/utils/calculate-snapshot-version.test.js

@@ -0,0 +1,57 @@
+import { git } from '../../common'
+import { calculateSnapshotVersion } from './calculate-snapshot-version'
+
+jest.mock('../../common')
+
+describe('calculateSnapshotVersion', () => {
+  beforeEach(() => {
+    git.getCommitTag.mockReturnValue('13246u')
+  })
+  it('should return the snapshot version', () => {
+    const context = {
+      nextRelease: { type: 'patch' },
+      lastRelease: {
+        version: '1.0.0'
+      },
+      config: {
+        REF_COMMIT: 'REF_COMMIT'
+      }
+    }
+
+    const version = calculateSnapshotVersion(context)
+    expect(git.getCommitTag).toHaveBeenCalledWith(context.config.REF_COMMIT)
+    expect(version).toEqual('1.0.1-beta13246u')
+  })
+
+  it('should return the snapshot version', () => {
+    const context = {
+      nextRelease: { type: 'minor' },
+      lastRelease: {
+        version: '1.0.0'
+      },
+      config: {
+        REF_COMMIT: 'REF_COMMIT'
+      }
+    }
+
+    const version = calculateSnapshotVersion(context)
+    expect(git.getCommitTag).toHaveBeenCalledWith(context.config.REF_COMMIT)
+    expect(version).toEqual('1.1.0-beta13246u')
+  })
+
+  it('should return the snapshot version', () => {
+    const context = {
+      nextRelease: { type: 'major' },
+      lastRelease: {
+        version: '1.0.0'
+      },
+      config: {
+        REF_COMMIT: 'REF_COMMIT'
+      }
+    }
+
+    const version = calculateSnapshotVersion(context)
+    expect(git.getCommitTag).toHaveBeenCalledWith(context.config.REF_COMMIT)
+    expect(version).toEqual('2.0.0-beta13246u')
+  })
+})

package/src/semantic-release/utils/display-package-info.js

@@ -0,0 +1,11 @@
+import { logSection } from './log-section'
+
+export function displayPackageInfo (context) {
+  logSection('Package Info', context)
+  context.logger.info('Name       : ' + context.config.PROJECT_NAME)
+  context.logger.info('Version    : ' + context.lastRelease.version)
+  context.logger.info('Repository : ' + context.config.REPOSITORY_URL)
+  context.logger.info('Branch     : ' + context.branch.name)
+  context.logger.info('Tag        : ' + context.lastRelease.gitTag)
+  context.logger.info('GitHead    : ' + context.lastRelease.gitHead)
+}

package/src/semantic-release/utils/display-release-info.js

@@ -0,0 +1,12 @@
+import { logSection } from './log-section'
+
+export function displayReleaseInfo (context) {
+  logSection('Release Info', context)
+  context.logger.info('Branch   : ' + context.branch.name)
+  context.logger.info('Build N° : ' + context.config.BUILD_NUMBER)
+  context.logger.info('Version  : ' + context.nextRelease.version)
+  context.logger.info('Tag      : ' + context.nextRelease.gitTag)
+  context.logger.info('GitHead  : ' + context.nextRelease.gitHead)
+  context.logger.info('Type     : ' + context.nextRelease.type)
+  context.logger.info('Channel  : ' + context.nextRelease.channel)
+}

package/src/semantic-release/utils/docker-clean-tags.js

@@ -0,0 +1,45 @@
+import { docker } from '../../common'
+
+function mapTags (tags) {
+  tags = tags
+    .map(tag => {
+      return {
+        name: tag.name,
+        date: new Date(tag.last_updated).getTime()
+      }
+    }).sort((a, b) => b.date - a.date)
+
+  let tagFound = false
+
+  return tags.reduce((result, tag) => {
+    if (tag.name.match(/\d+\.\d+\.\d+/)) {
+      tagFound = true
+    } else if (tagFound) {
+      result.push(tag)
+    }
+    return result
+  }, [])
+}
+
+export async function dockerCleanTags (context) {
+  const { logger, config: { DOCKER_HUB_ID, DOCKER_HUB_PWD, DOCKER_REPOSITORY } } = context
+
+  if (DOCKER_HUB_ID && DOCKER_HUB_PWD) {
+    logger.info('Start clean Docker Hub...')
+
+    const token = await docker.getToken(DOCKER_HUB_ID, DOCKER_HUB_PWD)
+    const options = {
+      token,
+      repository: DOCKER_REPOSITORY
+    }
+
+    const tags = mapTags(await docker.getTags(options))
+
+    await Promise.all(tags.map(async (tag) => {
+      await docker.deleteTag(tag.name, options)
+      logger.info(`TAG : ${tag.name} deleted`)
+    }))
+
+    logger.info('Docker Hub Clean !')
+  }
+}

package/src/semantic-release/utils/docker-clean-tags.test.js

@@ -0,0 +1,54 @@
+import { docker } from '../../common'
+import { dockerCleanTags } from './docker-clean-tags'
+
+jest.mock('../../common')
+
+describe('dockerCleanTags', () => {
+  beforeEach(() => {
+    docker.getToken.mockReturnValue('token')
+    docker.getTags.mockReturnValue([
+      {
+        name: 'branch-1',
+        last_updated: new Date('2020-06-01')
+      },
+      {
+        name: '1.1.0',
+        last_updated: new Date('2020-05-20')
+      },
+      {
+        name: 'branch-2',
+        last_updated: new Date('2020-05-01')
+      },
+      {
+        name: '1.0.0',
+        last_updated: new Date('2020-04-01')
+      }
+    ])
+  })
+  it('should clean obsolete tags', async () => {
+    const context = {
+      logger: {
+        info: jest.fn(),
+        warn: jest.fn()
+      },
+      config: {
+        DOCKER_HUB_ID: 'DOCKER_HUB_ID',
+        DOCKER_HUB_PWD: 'DOCKER_HUB_PWD',
+        DOCKER_REPOSITORY: 'DOCKER_REPOSITORY'
+      }
+    }
+
+    await dockerCleanTags(context)
+
+    expect(docker.getToken).toHaveBeenCalledWith('DOCKER_HUB_ID', 'DOCKER_HUB_PWD')
+    expect(docker.getTags).toHaveBeenCalledWith({
+      token: 'token',
+      repository: 'DOCKER_REPOSITORY'
+    })
+    expect(docker.deleteTag).toHaveBeenCalledWith('branch-2', {
+      token: 'token',
+      repository: 'DOCKER_REPOSITORY'
+    })
+    expect(docker.deleteTag).toHaveBeenCalledTimes(1)
+  })
+})

package/src/semantic-release/utils/docker-publish.js

@@ -0,0 +1,36 @@
+import { docker } from '../../common'
+import { heroku } from '../../common/cli/heroku'
+
+export async function dockerPublish (context) {
+  const { config: { DEPLOY_ON_DOCKER, DEPLOY_ON_HEROKU, SKIP_DEPLOY } } = context
+
+  if (!SKIP_DEPLOY) {
+    if (DEPLOY_ON_DOCKER) {
+      await deployOnDockerHub(context)
+    }
+
+    if (DEPLOY_ON_HEROKU) {
+      await deployOnHeroku(context)
+    }
+  }
+}
+
+export async function deployOnDockerHub (context) {
+  const { config: { PRODUCTION_BRANCH, DOCKER_REPOSITORY, DOCKER_HUB_ID, DOCKER_HUB_PWD } } = context
+
+  docker.login('-u', DOCKER_HUB_ID, '-p', DOCKER_HUB_PWD)
+
+  const image = PRODUCTION_BRANCH === context.branch.name ? `${DOCKER_REPOSITORY}:${context.nextRelease.version}` : `${DOCKER_REPOSITORY}:${context.branch.name}`
+
+  docker.tag(`${DOCKER_REPOSITORY}:latest`, image)
+
+  await docker.push(image)
+}
+
+export async function deployOnHeroku (context) {
+  const { config: { HEROKU_APP } } = context
+
+  heroku.containerLogin().sync()
+  await heroku.containerPush('web', '-a', HEROKU_APP)
+  await heroku.containerRelease('web', '-a', HEROKU_APP)
+}

package/src/semantic-release/utils/docker-publish.test.js

@@ -0,0 +1,43 @@
+import { dockerPublish } from './docker-publish'
+import { docker } from '../../common'
+
+jest.mock('../../common')
+
+describe('dockerPublish', () => {
+  it('should publish docker image', async () => {
+    const context = {
+      branch: {
+        name: 'branch-name'
+      },
+      config: {
+        DEPLOY_ON_DOCKER: true,
+        PRODUCTION_BRANCH: 'production',
+        DOCKER_REPOSITORY: 'owner',
+        DOCKER_HUB_ID: 'login',
+        DOCKER_HUB_PWD: 'password'
+      }
+    }
+    await dockerPublish(context)
+
+    expect(docker.login).toHaveBeenCalledWith('-u', 'login', '-p', 'password')
+    expect(docker.tag).toHaveBeenCalledWith('owner:latest', 'owner:branch-name')
+    expect(docker.push).toHaveBeenCalledWith('owner:branch-name')
+  })
+  it('should do nothing', async () => {
+    const context = {
+      branch: {
+        name: 'branch-name'
+      },
+      config: {
+        DEPLOY_ON_DOCKER: false,
+        PRODUCTION_BRANCH: 'production',
+        DOCKER_REPOSITORY: 'owner',
+        DOCKER_HUB_ID: 'login',
+        DOCKER_HUB_PWD: 'password'
+      }
+    }
+    await dockerPublish(context)
+
+    expect(docker.login).not.toHaveBeenCalled()
+  })
+})

package/src/semantic-release/utils/ghpages-publish.js

@@ -0,0 +1,16 @@
+import { join } from 'path'
+import { writeFileSync } from 'fs'
+import { git } from '../../common'
+
+export async function ghPagesPublish (context) {
+  const { config: { GITHUB_PAGES_PATH: cwd, GH_TOKEN, REPOSITORY_URL } } = context
+  const repository = REPOSITORY_URL.replace('https://', '')
+
+  writeFileSync(join(cwd, '.nojekyll'), '', { encoding: 'utf8' })
+
+  git.init().cwd(cwd).sync()
+  git.add('-A').cwd(cwd).sync()
+  git.commit('-m', 'Deploy documentation v' + context.nextRelease.version).cwd(cwd).sync()
+
+  await git.push('-f', GH_TOKEN ? `https://${GH_TOKEN}@${repository}` : `https://${repository}`, 'master:gh-pages').cwd(cwd)
+}

package/src/semantic-release/utils/log-section.js

@@ -0,0 +1,5 @@
+export function logSection (title, context) {
+  context.logger.info('-----------------------------------')
+  context.logger.info(`--- ${title}`)
+  context.logger.info('-----------------------------------')
+}

package/src/workflow/index.js

@@ -0,0 +1,37 @@
+export const WORKFLOW_CONFIGURATION = [
+  {
+    type: 'feat',
+    label: 'Features',
+    release: 'minor'
+  },
+  {
+    type: 'fix',
+    label: 'Bug Fixes',
+    release: 'patch'
+  },
+  {
+    type: 'chore',
+    label: 'Chores',
+    release: false
+  },
+  {
+    type: 'ci',
+    label: 'CI',
+    release: false
+  },
+  {
+    type: 'docs',
+    label: 'Documentation',
+    release: 'patch'
+  },
+  {
+    type: 'tech',
+    label: 'Technical Improvements',
+    release: 'patch'
+  },
+  {
+    type: 'default',
+    label: 'Miscellaneous',
+    release: false
+  }
+]