Ws week picker range

CONTRIBUTING.MD

@@ -26,6 +26,8 @@ You'll get feedback about your pull request as soon as possible.
 
 As we are generating changelogs based on successfully merged pull-requests we have to enforce a specific layout for git commit messages. 
 
+The general layout of commit messages should be `<type>(<component(s)>): <message>`
+
 _patches:_
 
 ```sh
@@ -43,5 +45,5 @@ _other changes:_
 You decide, e.g., docs, chore, etc.
 
 ```sh
-git commit -a -m "docs: fixed up the docs a bit"
-```
+git commit -a -m "docs(component): fixed up the docs a bit"
+```

build/args.js

@@ -1,14 +1,16 @@
-var yargs = require('yargs');
+const yargs = require('yargs');
 
-var argv = yargs.argv;
-var validBumpTypes = 'major|minor|patch|prerelease'.split('|');
-var bump = (argv.bump || 'patch').toLowerCase();
+const argv = yargs.argv;
+const validBumpTypes = 'major|minor|patch|prerelease'.split('|');
+const bump = (argv.bump || 'patch').toLowerCase();
 
 if (validBumpTypes.indexOf(bump) === -1) {
   throw new Error('Unrecognized bump "' + bump + '".');
 }
 
 module.exports = {
-  bump: bump,
-  depth: parseInt(argv.depth || '0')
+  bump,
+  depth: parseInt(argv.depth || '0', 10),
+  token: argv.token,
+  branch: argv.branch
 };

build/paths.js

@@ -1,6 +1,5 @@
 const appRoot = 'src/';
 const outputRoot = 'dist/';
-const docsOutput = 'docs/';
 const testRoot = 'tests/';
 
 module.exports = {
@@ -10,7 +9,8 @@ module.exports = {
   html: appRoot + '**/*.html',
   css: appRoot + '**/*.scss',
   output: outputRoot,
-  docsOutput: docsOutput.concat('api/'),
+  doc: './doc',
+  apiDoc: './doc/api',
   e2eSpecsSrc: 'test/e2e/src/*.js',
   e2eSpecsDist: 'test/e2e/dist/'
 };

build/tasks/docs.js

@@ -6,45 +6,57 @@ const glob = require('glob');
 const del = require('del');
 const vinylPaths = require('vinyl-paths');
 const docjs = require('documentation');
+const REGEX_FILE_NAME = /((\w)+(-)*(\w))+(?=.js)/g;
 
+function createDocForFile(filename) {
+  const splittedName = filename.split('/');
+  const filenameWithoutExt = filename.match(REGEX_FILE_NAME)[0];
 
+  return docjs.build([filename], {shallow: true})
+    .then(result => docjs.formats.md(result, {}))
+    .then(output => ({
+      file: filenameWithoutExt,
+      // get the parent folder of file
+      folder: filenameWithoutExt !== 'index' ? splittedName[splittedName.length - 2] : 'index',
+      markdown: output
+    }));
+}
 
 // deletes all files in the output path
 gulp.task('clean-docs', () =>
-  gulp.src([`${paths.docsOutput}`])
+  gulp.src([`${paths.apiDoc}`])
     .pipe(vinylPaths(del))
 );
 
-gulp.task('build-jsdoc-to-md', () => {
-  const files = glob.sync(paths.source); // glob allows pattern matching for filenames
-  const regexFileName = /((\w)+(\-)*(\w))+(?=.js)/g;
-  const createdMdDocs = [];
-  files
-  .filter(filename => {
-    const name = filename.match(regexFileName)[0];
-    return name !== 'imports';
-  })
-  .map(filename => {
-    const splittedName = filename.split('/');
-    const filenameWithoutExt = filename.match(regexFileName)[0];
-    const jsDocObj = docjs.buildSync([filename], {shallow: true});
-    return docjs.formats.md(jsDocObj, {}, (err, output) => {
-      createdMdDocs.push({
-        file: filenameWithoutExt,
-        folder: filenameWithoutExt !== 'index' ? splittedName[splittedName.length - 2] : '',  // get the parent folder of file
-        markdown: output
-      });
-    });
-  });
-  const writeMdFiles = createdMdDocs.map(mdDoc => {
-    const folder = `${paths.docsOutput}${mdDoc.folder}`;
-    const filePath = mdDoc.file !== 'index' ? `${paths.docsOutput}${mdDoc.folder}/${mdDoc.file}.md` : `${paths.docsOutput}${mdDoc.file}.md`;
-    if (!fs.existsSync(folder)) {
-      fs.mkdirSync(folder);
-    }
-    return fs.writeFile(filePath, mdDoc.markdown);
-  });
-  return Promise.all(writeMdFiles);
+gulp.task('build-jsdoc-to-md', done => {
+  Promise.resolve(glob.sync(paths.source))
+    // Filter file names to match tag name pattern
+    .then(fileNames => fileNames.filter(fileName => {
+      const name = fileName.match(REGEX_FILE_NAME)[0];
+      return name !== 'imports' && name !== 'index';
+    }))
+    // Generate markdown for each file
+    .then(fileNames =>
+      Promise.all(fileNames.map(createDocForFile))
+    )
+    // Group the markdown docs by there folder
+    .then(docs => docs.reduce((groups, doc) => {
+      groups[doc.folder] = groups[doc.folder] || [];
+      groups[doc.folder].push(doc);
+      return groups;
+    }, {}))
+    // Create markdown files for each folder
+    .then(groups => Object.keys(groups).forEach(folderName => {
+      const group = groups[folderName];
+      const fileName = `${paths.apiDoc}/${folderName}.md`;
+      const normalize = doc => doc.markdown.replace(/<!--.*?-->\n*/g, '');
+      const content = `# ${folderName}\n${group.map(normalize).join('')}`;
+      if (!fs.existsSync(paths.apiDoc)) {
+        fs.mkdirSync(paths.apiDoc);
+      }
+      fs.writeFileSync(fileName, content);
+    }))
+    .then(done);
 });
 
 gulp.task('generate-docs', done => runSequence('clean-docs', 'build-jsdoc-to-md', done));

build/tasks/lint.js

@@ -1,11 +1,35 @@
-var gulp = require('gulp');
-var paths = require('../paths');
-var eslint = require('gulp-eslint');
+const gulp = require('gulp');
+const paths = require('../paths');
+const eslint = require('gulp-eslint');
+const runSequence = require('run-sequence');
+const glob = require('glob');
+const docjs = require('documentation');
+const REGEX_FILE_NAME = /((\w)+(-)*(\w))+(?=.js)/g;
 
 // runs eslint on all .js files
-gulp.task('lint', function() {
-  return gulp.src([paths.source, paths.tests])
+gulp.task('eslint', () =>
+  gulp.src([paths.source, paths.tests])
     .pipe(eslint())
     .pipe(eslint.format())
-    .pipe(eslint.failOnError());
-});
+    .pipe(eslint.failOnError())
+);
+
+gulp.task('doc-lint', () =>
+  Promise.resolve(glob.sync(paths.source))
+    // Filter file names to match tag name pattern
+    .then(fileNames => fileNames.filter(fileName => {
+      const name = fileName.match(REGEX_FILE_NAME)[0];
+      return name !== 'imports';
+    }))
+    // Generate markdown for each file
+    .then(fileNames => fileNames.map(fileName =>
+      docjs.lint(fileName, {}).then(lintOutput => {
+        console.log(lintOutput);
+      })
+    ))
+    .then(promises => Promise.all(promises))
+);
+
+gulp.task('lint', done =>
+  runSequence(['eslint', 'doc-lint'], done)
+);

build/tasks/prepare-release.js

@@ -1,40 +1,71 @@
-var gulp = require('gulp');
-var runSequence = require('run-sequence');
-var paths = require('../paths');
-var changelog = require('conventional-changelog');
-var fs = require('fs');
-var bump = require('gulp-bump');
-var args = require('../args');
+const gulp = require('gulp');
+const runSequence = require('run-sequence');
+const paths = require('../paths');
+const conventionalChangelog = require('gulp-conventional-changelog');
+const conventionalGitHubReleaser = require('conventional-github-releaser');
+const bump = require('gulp-bump');
+const args = require('../args');
+const changelogOpts = {
+  preset: 'angular',
+  releaseCount: 1,
+  targetCommitish: args.branch
+};
 
 // utilizes the bump plugin to bump the
 // semver for the repo
-gulp.task('bump-version', function() {
-  return gulp.src(['./package.json'])
-    .pipe(bump({type: args.bump})) //major|minor|patch|prerelease
-    .pipe(gulp.dest('./'));
-});
+gulp.task('bump-version', () =>
+  gulp.src(['./package.json'])
+    .pipe(bump({type: args.bump}))
+    .pipe(gulp.dest('./'))
+);
 
 // generates the CHANGELOG.md file based on commit
 // from git commit messages
-gulp.task('changelog', function(callback) {
-  var pkg = JSON.parse(fs.readFileSync('./package.json', 'utf-8'));
-
-  return changelog({
-    repository: pkg.repository.url,
-    version: pkg.version,
-    file: paths.doc + '/CHANGELOG.md'
-  }, function(err, log) {
-    fs.writeFileSync(paths.doc + '/CHANGELOG.md', log);
-  });
-});
+gulp.task('changelog', () =>
+  gulp.src(`${paths.doc}/CHANGELOG.md`)
+    .pipe(conventionalChangelog(changelogOpts))
+    .pipe(gulp.dest(paths.doc))
+);
 
 // calls the listed sequence of tasks in order
-gulp.task('prepare-release', function(callback) {
-  return runSequence(
+gulp.task('prepare-release', callback =>
+  runSequence(
     'build',
     'lint',
     'bump-version',
     'changelog',
     callback
-  );
+  )
+);
+
+gulp.task('release', callback => {
+  conventionalGitHubReleaser({
+    type: 'oauth',
+    token: args.token || process.env.CONVENTIONAL_GITHUB_RELEASER_TOKEN
+  }, changelogOpts, {}, {}, {}, {}, (err, data) => {
+    if (err) {
+      console.error(err.toString());
+      return callback();
+    }
+
+    if (!data.length) {
+      console.log('No GitHub releases created because no git tags available to work with.');
+      return callback();
+    }
+
+    let allRejected = true;
+    for (let i = data.length - 1; i >= 0; i--) {
+      if (data[i].state === 'fulfilled') {
+        allRejected = false;
+        break;
+      }
+    }
+
+    if (allRejected) {
+      console.error(data);
+    } else {
+      console.log(data);
+    }
+    return callback();
+  });
 });

circle.yml

@@ -8,20 +8,23 @@ machine:
 
 general:
   artifacts:
-      - "styleguide/index.html"
-      - "styleguide/scripts"
-      - "styleguide/src/style/assets"
+    - "styleguide/index.html"
+    - "styleguide/scripts"
+    - "styleguide/src/style/assets"
   branches:
     ignore:
       - gh-pages
 
 checkout:
   post:
+    - git pull origin ${CIRCLE_BRANCH}
     - git clone [email protected]:wholesale-design-system/styleguide.git
-    - git config --global user.email circleci@circleci
+    - git config --global user.email [email protected]
     - git config --global user.name "${CIRCLE_PROJECT_USERNAME}"
 
 dependencies:
+  pre:
+    - sudo apt-get update; sudo apt-get install jq
   override:
     - npm install -g gulp-cli aurelia-cli
     - npm install
@@ -38,7 +41,20 @@ test:
     - gulp test
 
 deployment:
-  master:
+  release:
+    branch: [master, release]
+    commands:
+      - gulp generate-docs bump-version changelog
+      - git add package.json doc dist
+      - git commit -m "Bumped version to $(jq -r .version package.json) [skip ci]"
+      - git tag -f -a $(jq -r .version package.json) -m "Automatic release via CircleCI"
+      - git push origin $CIRCLE_BRANCH
+      - gulp release --branch="${CIRCLE_BRANCH}"
+      - au build:
+          pwd: styleguide
+      - au publish --commit ${CIRCLE_SHA1} --repo "${CIRCLE_PROJECT_REPONAME}/${CIRCLE_BRANCH}" --target "${TARGET}":
+          pwd: styleguide
+  styleguide:
     branch: /.*/
     commands:
       - au build: