Merge pull request #492 from primer/release-10.6.0

10.6.0 Release Tracking PR

.gitignore

@@ -1,7 +1,6 @@
 .DS_Store
 .sass-cache
 node_modules
-**/package-lock.json
 *.log
 build
 _site

.npmrc

@@ -0,0 +1,2 @@
+save=true
+save-exact=true

.nvmrc

@@ -0,0 +1 @@
+8

CHANGELOG.md

@@ -1,3 +1,22 @@
+# 10.6.0
+
+#### :bug: Bug Fix
+* [#491](https://github.com/primer/primer/pull/491) Add `backface-visibility` to `.hover-grow`. ([@brandonrosage](https://github.com/brandonrosage))
+
+#### :memo: Documentation
+* [#490](https://github.com/primer/primer/pull/490) Add release documentation. ([@emplums](https://github.com/emplums))
+
+#### :house: Internal
+* [#475](https://github.com/primer/primer/pull/475) Import primer-module-build to the monorepo. ([@shawnbot](https://github.com/shawnbot))
+* [#479](https://github.com/primer/primer/pull/479) Add "scoreboard" test suite. ([@shawnbot](https://github.com/shawnbot))
+
+#### Committers: 4
+- Brandon Rosage ([brandonrosage](https://github.com/brandonrosage))
+- Emily ([emplums](https://github.com/emplums))
+- Shawn Allen ([shawnbot](https://github.com/shawnbot))
+- [muan](https://github.com/muan)
+
+
 # 10.5.0
 
 #### :rocket: Enhancement

README.md

@@ -61,6 +61,10 @@ For a compiled **CSS** version of this module, an npm script is included that wi
 $ npm run build
 ```
 
+## Releasing (Staff only)
+
+You can find docs about our release process in [RELEASING.md](./RELEASING.md).
+
 ## Documentation
 
 You can read more about primer in the [docs][docs].

RELEASING.md

@@ -0,0 +1,68 @@
+## Releasing a new Primer version 🎉
+
+
+### In `primer/primer`:
+
+1. Create a new release branch from `dev` and name it `release-<version>`.
+
+ (CI will publish a release candidate version to npm for branches prefixed with `release`. These version numbers have a `rc.<number>` suffix on them)
+
+2. Go through the tracking issue and make sure everything that should be merged in is merged in.
+
+3. Once your builds finish, click on the details links for the continuous-integration/travis-ci/push build.  Expand the `Deploying application` output and you should be able to find an outputted change log here. Copy this and update the [CHANGELOG.md](https://github.com/primer/primer/blob/master/CHANGELOG.md) file.
+
+4. Run the version bump in your terminal: `npm run bump`.
+
+5. Test your changes with the latest release candidate version in the appropriate places (styleguide, storybook, github/github).
+
+6. Once the release PR is approved and you've done necessary testing, merge to `master`. This will trigger a publish to npm.
+
+
+### In `github/github`:
+
+1. Create a new branch
+
+2. Update the primer version in your terminal  `npm install primer@<version>`.
+
+3. Update `stylelint-config-primer` in your terminal to the appropriate version `npm install stylelint-config-primer@latest`.
+
+4. If you need to make changes to github/github due to the Primer release, make a separate branch. When ready, merge that branch into your release branch.
+
+5. Add reviewers.
+
+6. Check that every deleted vendor file has an accompanying updated vendor file and that the version numbers look correct.
+
+7. Test on review-lab.
+
+8. When ready, merge! 🎉
+
+
+## Other items that need to be done after publishing Primer
+
+#### Update the Style Guide
+
+1. In [github/styleguide](https://github.com/github/styleguide), update `primer` to your newly released version in your terminal:
+
+  `npm install primer@latest`
+
+2. Then  run: `script/update-primer-docs`.
+
+3. Commit changes, make PR, get it approved, merge! 🚀
+
+#### Update [primer.github.io](primer.github.io)
+
+1. Edit  [index.html](https://github.com/primer/primer.github.io/blob/master/index.html) to include the latest version.
+
+#### Update Storybook
+
+1. Pull the latest from master on primer/primer (after merging in release branch).
+
+2. Run `npm run publish-storybook`.
+
+#### Publish release tag
+
+1. Create a new release tag [here](https://github.com/primer/primer/releases/new).
+
+2. Copy the changes from the [CHANGELOG](https://github.com/primer/primer/blob/master/CHANGELOG.md) and paste it into the release notes.
+
+3. Publish 🎉

meta/scoreboard/index.js

@@ -0,0 +1,96 @@
+const {basename, join, resolve} = require('path')
+const PromiseQueue = require('p-queue')
+const execa = require('execa')
+const globby = require('globby')
+const rootDir = resolve(__dirname, '../..')
+const lernaConfig = require(join(rootDir, 'lerna.json'))
+const modulesDir = join(rootDir, 'modules')
+require('console.table')
+
+const unique = list => Array.from(new Set(list)).sort()
+
+const matchAll = (pattern, text) => {
+  const matches = []
+  let match
+  while (match = pattern.exec(text)) {
+    matches.push(match)
+  }
+  return matches
+}
+
+const checks = {
+  'has stories': (module, key) => {
+    return globby(join(module.path, '**/stories.js'))
+      .then(files => ({
+        [key]: files.length > 0 ? 'yes' : 'no'
+      }))
+  },
+  'docs test': (module, key) => {
+    return execa(join(rootDir, 'script/test-docs'), {
+      cwd: module.path
+    })
+    .then(result => ({[key]: 'pass'}))
+    .catch(({stderr}) => {
+      const pattern = /("\.[-\w]+") is not documented/g
+      const matches = matchAll(pattern, stderr)
+        .map(match => match[1])
+      let missing = matches ? Array.from(matches) : []
+      const max = 5
+      if (missing.length > max) {
+        const more = missing.length - max
+        missing = missing.slice(0, max).concat(`and ${more} more...`)
+      }
+      return {
+        [key]: 'FAIL',
+        'missing docs': unique(missing).join(', ')
+      }
+    })
+  }
+}
+
+const args = process.argv.slice(2)
+
+const modules = args.length
+  ? Promise.resolve(args)
+  : globby(join(modulesDir, 'primer-*'))
+
+modules
+  .then(moduleDirs => {
+    console.log('Found %d module directories', moduleDirs.length)
+    return moduleDirs
+      .map(path => ({
+        path,
+        name: basename(path),
+        pkg: require(join(path, 'package.json'))
+      }))
+      .filter(({pkg}) => pkg.primer.module_type !== 'meta')
+  })
+  .then(modules => {
+    console.log('Filtered to %d modules (excluding meta-packages)', modules.length)
+
+    const queue = new PromiseQueue({concurrency: 3})
+
+    for (const module of modules) {
+      module.checks = {}
+      for (const [name, check] of Object.entries(checks)) {
+        queue.add(() => {
+          // console.warn(`? check: ${module.name} ${name}`)
+          return check(module, name)
+            .then(result => {
+              Object.assign(module.checks, result)
+            })
+        })
+      }
+    }
+
+    console.warn(`Running ${queue.size} checks...`)
+    return queue.onIdle().then(() => modules)
+  })
+  .then(modules => {
+    console.warn('ran tests on %d modules', modules.length)
+    const rows = modules.map(({name, checks}) => {
+      return Object.assign({'package': name}, checks)
+    })
+    console.table(rows)
+  })
+

meta/scoreboard/package.json

@@ -0,0 +1,13 @@
+{
+  "private": true,
+  "name": "primer-scorecard",
+  "scripts": {
+    "test": "node index.js"
+  },
+  "devDependencies": {
+    "console.table": "^0.10.0",
+    "execa": "^0.10.0",
+    "globby": "^6.1.0",
+    "p-queue": "^2.4.2"
+  }
+}

modules/primer-alerts/lib/flash.scss

@@ -72,6 +72,7 @@
   border-radius: 0;
 }
 
+// FIXME deprecate this
 .warning {
   padding: $em-spacer-5;
   margin-bottom: 0.8em;

modules/primer-alerts/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.5.6",
+  "version": "1.5.7",
   "name": "primer-alerts",
   "description": "Flash messages, or alerts, inform users of successful or pending actions.",
   "homepage": "http://primer.github.io/",
@@ -10,7 +10,10 @@
   "main": "build/index.js",
   "primer": {
     "category": "product",
-    "module_type": "components"
+    "module_type": "components",
+    "class_whitelist": [
+      "warning"
+    ]
   },
   "files": [
     "index.scss",
@@ -28,7 +31,7 @@
     "test": "../../script/npm-run-all build lint"
   },
   "dependencies": {
-    "primer-support": "4.5.3"
+    "primer-support": "4.5.4"
   },
   "keywords": [
     "alerts",

modules/primer-avatars/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.5.3",
+  "version": "1.5.4",
   "name": "primer-avatars",
   "description": "Basic styles for user profile avatars.",
   "homepage": "http://primer.github.io/",
@@ -28,7 +28,7 @@
     "test": "../../script/npm-run-all build lint"
   },
   "dependencies": {
-    "primer-support": "4.5.3"
+    "primer-support": "4.5.4"
   },
   "keywords": [
     "avatars",

modules/primer-base/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.7.1",
+  "version": "1.7.2",
   "name": "primer-base",
   "description": "CSS to reset the browsers default styles",
   "homepage": "http://primer.github.io/",
@@ -10,7 +10,11 @@
   "main": "build/index.js",
   "primer": {
     "category": "core",
-    "module_type": "support"
+    "module_type": "support",
+    "class_whitelist": [
+      "octicon",
+      "rule"
+    ]
   },
   "files": [
     "index.scss",
@@ -28,7 +32,7 @@
     "test": "../../script/npm-run-all build lint"
   },
   "dependencies": {
-    "primer-support": "4.5.3"
+    "primer-support": "4.5.4"
   },
   "keywords": [
     "primer",

modules/primer-blankslate/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.4.6",
+  "version": "1.4.7",
   "name": "primer-blankslate",
   "description": "Blankslates are for when there is a lack of content within a page or section.",
   "homepage": "http://primer.github.io/",
@@ -28,7 +28,7 @@
     "test": "../../script/npm-run-all build lint"
   },
   "dependencies": {
-    "primer-support": "4.5.3"
+    "primer-support": "4.5.4"
   },
   "keywords": [
     "primer",

modules/primer-box/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.5.6",
+  "version": "2.5.7",
   "name": "primer-box",
   "description": "A module for creating rounded-corner boxes with options for headers, lists, and footers.",
   "homepage": "http://primer.github.io/",
@@ -28,7 +28,7 @@
     "test": "../../script/npm-run-all build lint"
   },
   "dependencies": {
-    "primer-support": "4.5.3"
+    "primer-support": "4.5.4"
   },
   "keywords": [
     "primer",