Feat/GitHub actions

.circleci/config.yml

@@ -61,7 +61,7 @@ jobs:
         key: *js_deps_cache_key
   build_v3:
     docker:
-    - image: circleci/ruby:latest-node
+    - image: circleci/ruby:2-node
     steps:
     - checkout
     - restore_cache:

.github/release.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+GIT_USERNAME="patternfly-build"
+GH_REPO=${GITHUB_REPOSITORY}
+REPO="github.com:${GH_REPO}.git"
+echo "Preparing release environment..."
+git config user.email "[email protected]"
+git config user.name ${GIT_USERNAME}
+git config credential.helper store
+echo "https://${GIT_USERNAME}:${GH_TOKEN}@${REPO}" > ~/.git-credentials
+echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
+
+echo "Doing a release..."
+# Lerna is complicated. Commands: https://github.com/lerna/lerna/tree/master/commands
+# Identify packages that have been updated since the previous tagged release
+# Update their versions and changelogs according to angular commit guidelines
+# https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
+
+# Grab the log before lerna makes a commit
+LOG=$(git log --format="%s" -1 | grep -Poe "#\d+")
+PR_NUM=${LOG:1}
+
+yarn run lerna publish --conventional-commits --create-release=github --yes 2>&1 | tee lerna-output.txt
+
+if grep -i "Successfully published" lerna-output.txt; # Leave a Github comment
+then
+  if [ -n "${PR_NUM}" ]
+  then
+    # Use Issues api instead of PR api because
+    # PR api requires comments be made on specific files of specific commits
+    GH_PR_COMMENTS="https://api.github.com/repos/${GH_REPO}/issues/${PR_NUM}/comments"
+    COMMENT=$(git log --author="patternfly-build" -1 --pretty=%B | tail -n +2 | python -c 'import json,sys; print(json.dumps(sys.stdin.read()))' | cut -d '"' -f 2)
+    JSON="{\"body\":\"Your changes have been released in: ${COMMENT}Thanks for your contribution! :tada:\"}"
+    echo "Adding github PR comment ${GH_PR_COMMENTS} ${JSON}"
+    curl -H "Authorization: token ${GH_PR_TOKEN}" --request POST "${GITHUB_PR_COMMENTS}" --data "${JSON}"
+  fi
+elif grep -i "No changed packages to publish" lerna-output.txt;
+then
+  echo "No changed packages to publish"
+else
+  echo "Failed lerna publish"
+  exit 1
+fi

.github/upload-preview.js

@@ -0,0 +1,88 @@
+const path = require('path');
+const { Octokit } = require('@octokit/rest')
+const octokit = new Octokit({ auth: process.env.GH_PR_TOKEN });
+const surge = require('surge');
+const publishFn = surge().publish();
+
+// From github actions
+const ghrepo = process.env.GITHUB_REPOSITORY || '';
+const ghref = process.env.GITHUB_REF || '';
+
+// From CircleCI
+const owner = process.env.CIRCLE_PROJECT_USERNAME || ghrepo.split('/')[0]; // patternfly
+const repo = process.env.CIRCLE_PROJECT_REPONAME || ghrepo.split('/')[1];
+const prnum = process.env.CIRCLE_PR_NUMBER || (ghref.match(/pull\/(\d+)/) || [])[1];
+// Can contain special characters but surge replaces them
+const branch = process.env.CIRCLE_BRANCH || ghref.replace('refs/heads/', '');
+
+const uploadFolder = process.argv[2];
+const uploadName = process.argv[3] || uploadFolder;
+if (!uploadFolder) {
+  console.log('Usage: upload-preview uploadFolder');
+  process.exit(1);
+}
+
+const uploadFolderName = path.basename(uploadFolder);
+let uploadURL = `${repo}-${prnum ? `pr-${prnum}` : branch}`.replace(/[\/|\.]/g, '-');
+
+uploadURL += `-${uploadName}`;
+uploadURL += '.surge.sh';
+
+publishFn({
+  project: uploadFolder,
+  p: uploadFolder,
+  domain: uploadURL,
+  d: uploadURL,
+  e: 'https://surge.surge.sh',
+  endpoint: 'https://surge.surge.sh'
+});
+
+function tryAddComment(comment, commentBody) {
+  if (!commentBody.includes(comment)) {
+    return comment;
+  }
+  return '';
+}
+
+if (prnum) {
+  octokit.issues.listComments({
+    owner,
+    repo,
+    issue_number: prnum
+  })
+    .then(res => res.data)
+    .then(comments => {
+      let commentBody = '';
+      const existingComment = comments.find(comment => comment.user.login === 'patternfly-build');
+      if (existingComment) {
+        commentBody += existingComment.body.trim();
+        commentBody += '\n';
+      }
+
+      if (uploadName === 'v3') {
+        commentBody += tryAddComment(`PF3 preview: https://${uploadURL}/v3`, commentBody);
+      }
+      else if (uploadName === 'v4') {
+        commentBody += tryAddComment(`PF4 preview: https://${uploadURL}/v4`, commentBody);
+      }
+      else if (uploadFolderName === 'coverage') {
+        commentBody += tryAddComment(`A11y report: https://${uploadURL}`, commentBody);
+      }
+
+      if (existingComment) {
+        octokit.issues.updateComment({
+          owner,
+          repo,
+          comment_id: existingComment.id,
+          body: commentBody
+        }).then(() => console.log('Updated comment!'));
+      } else {
+        octokit.issues.createComment({
+          owner,
+          repo,
+          issue_number: prnum,
+          body: commentBody
+        }).then(() => console.log('Created comment!'));
+      }
+    });
+}

.github/upload-staging.sh

@@ -0,0 +1,17 @@
+aws s3 rm --recursive s3://patternfly-org-staging
+# TODO: Proper S3 meta tags for redirects
+aws s3 sync build/patternfly-org s3://patternfly-org-staging --exclude "*" \
+    --include "*.html" \
+    --include "*.json" \
+    --exclude "static/**/*.json" \
+    --include "sw.js" \
+    --cache-control "public, max-age=0, must-revalidate"
+
+aws s3 sync build/patternfly-org s3://patternfly-org-staging --include "*" \
+    --exclude "*.html" \
+    --exclude "*.json" \
+    --include "static/**/*.json" \
+    --exclude "sw.js" \
+    --cache-control "public, max-age=31536000, immutable"
+
+aws cloudfront create-invalidation --distribution-id EQE4NPRH0CQXJ --paths "/*"

.github/workflows/build.yml

@@ -0,0 +1,88 @@
+name: build-deploy
+on:
+  push:
+  pull_request:
+    branches:
+      # Branches from forks have the form 'user:branch-name' so we only run
+      # this job on pull_request events for branches that look like fork
+      # branches. Without this we would end up running this job twice for non
+      # forked PRs, once for the push and then once for opening the PR.
+    - '**:**'jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    env:
+      SURGE_LOGIN: ${{ secrets.SURGE_LOGIN }}
+      SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
+      GH_PR_TOKEN: ${{ secrets.GH_PR_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12'
+      - uses: actions/cache@v2
+        id: yarn-cache
+        name: Load v3 and v4 npm deps from cache
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-yarn-${{ hashFiles('yarn.lock') }}
+      - run: yarn install --frozen-lockfile
+        if: steps.yarn-cache.outputs.cache-hit != 'true'
+      # v4 build
+      - uses: actions/cache@v2
+        id: v4-cache
+        name: Load webpack cache
+        with:
+          path: 'packages/v4/.cache'
+          key: ${{ runner.os }}-v4-${{ hashFiles('yarn.lock') }}
+      - run: yarn build:v4
+        name: Build docs
+      - run: node .github/upload-preview.js build/patternfly-org v4
+        name: Upload docs
+      # v3 build
+      - uses: actions/cache@v2
+        id: v3-artifact-cache
+        name: Load v3 artifact from cache
+        with:
+          path: 'build/patternfly-org/v3'
+          key: ${{ runner.os }}-build-${{ hashFiles('packages/v3/*', 'packages/v3/**') }}
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+        if: steps.v3-artifact-cache.outputs.cache-hit != 'true'
+      - run: cd packages/v3 && bundle install --jobs 4 --retry 3
+        name: Install v3 ruby deps
+        if: steps.v3-artifact-cache.outputs.cache-hit != 'true'
+      - run: yarn build:v3
+        name: Build v3 docs
+        if: steps.v3-artifact-cache.outputs.cache-hit != 'true'
+      # temporarily move v4 out of the way
+      - run: mv build/patternfly-org/v4 build
+        name: Prep upload v3 docs
+      - run: node .github/upload-preview.js build/patternfly-org v3
+        name: Upload v3 docs
+        # only take the time to upload v3 if there's a change
+        if: steps.v3-artifact-cache.outputs.cache-hit != 'true'
+      # deploy
+      #- run: mv build/v4 build/patternfly-org
+      #  name: Undo prep upload v3 docs
+      #- run: .github/release.sh
+      #  env:
+      #    GH_TOKEN: ${{ secrets.GH_TOKEN }}
+      #  if: github.ref == 'refs/heads/master'
+      #- name: Configure AWS Credentials
+      #  uses: aws-actions/configure-aws-credentials@v1
+      #  with:
+      #    aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY}}
+      #    aws-secret-access-key: ${{ secrets.AWS_SECRET_KEY }}
+      #    aws-region: ${{ secrets.AWS_REGION }}
+      #  if: github.ref == 'refs/heads/master'
+      #- run: node scripts/writeV3Redirects.js
+      #  if: github.ref == 'refs/heads/master'
+      #- run: node scripts/writeVersionPrefix.js
+      #  if: github.ref == 'refs/heads/master'
+      #- run: du -sh build/patternfly-org/*
+      #  name: Check size of docs
+      #  if: github.ref == 'refs/heads/master'
+      #- run: .github/upload-staging.sh
+      #  name: Upload docs to staging
+

package.json

@@ -10,10 +10,10 @@
     "develop:v4": "yarn workspace patternfly-org-4 develop",
     "build": "yarn build:v4",
     "build:analyze": "yarn workspace patternfly-org-4 build:analyze && yarn copy:v4",
+    "build:v4": "yarn workspace patternfly-org-4 build && yarn copy:v4",
     "build:v3": "yarn workspace patternfly-org-3 build && yarn copy:v3",
-    "build:v4": "yarn workspace patternfly-org-4 build && sleep 1 && yarn copy:v4",
     "copy:v3": "rm -rf build/patternfly-org/v3 && mkdir -p build/patternfly-org && cp -r packages/v3/_site build/patternfly-org/v3",
-    "copy:v4": "rm -rf build/patternfly-org/v4 && mkdir -p build/patternfly-org && cp -r packages/v4/public/ build/patternfly-org/v4 && cp -r build/patternfly-org/v4/assets build/patternfly-org/assets",
+    "copy:v4": "rm -rf build/patternfly-org/v4 && mkdir -p build/patternfly-org && cp -r packages/v4/public build/patternfly-org/v4 && cp -r build/patternfly-org/v4/assets build/patternfly-org/assets",
     "clean": "lerna run clean && rm -rf build",
     "serve": "serve build/patternfly-org",
     "test:v4": "yarn workspace patternfly-org-4 test:a11y:ci",
@@ -31,6 +31,7 @@
     ]
   },
   "devDependencies": {
+    "@octokit/rest": "^16.43.2",
     "glob": "^7.1.6",
     "lerna": "^3.19.0",
     "surge": "^0.21.3"

packages/theme-patternfly-org/CHANGELOG.md

@@ -3,6 +3,49 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.3.0](https://github.com/patternfly/patternfly-org/compare/[email protected]@0.3.0) (2021-01-04)
+
+
+### Features
+
+* **docgen:** add [@prop](https://github.com/prop)Type and fix [@hide](https://github.com/hide) ([#2334](https://github.com/patternfly/patternfly-org/issues/2334)) ([e418ac6](https://github.com/patternfly/patternfly-org/commit/e418ac67f31017a6489dbeea5e964a42e6c97cbc))
+
+
+
+
+
+## [0.2.15](https://github.com/patternfly/patternfly-org/compare/[email protected]@0.2.15) (2020-12-15)
+
+**Note:** Version bump only for package theme-patternfly-org
+
+
+
+
+
+## [0.2.14](https://github.com/patternfly/patternfly-org/compare/[email protected]@0.2.14) (2020-12-14)
+
+**Note:** Version bump only for package theme-patternfly-org
+
+
+
+
+
+## [0.2.13](https://github.com/patternfly/patternfly-org/compare/[email protected]@0.2.13) (2020-12-08)
+
+**Note:** Version bump only for package theme-patternfly-org
+
+
+
+
+
+## [0.2.12](https://github.com/patternfly/patternfly-org/compare/[email protected]@0.2.12) (2020-12-03)
+
+**Note:** Version bump only for package theme-patternfly-org
+
+
+
+
+
 ## [0.2.11](https://github.com/patternfly/patternfly-org/compare/[email protected]@0.2.11) (2020-11-30)
 
 **Note:** Version bump only for package theme-patternfly-org

packages/theme-patternfly-org/app.js

@@ -29,14 +29,25 @@ const SideNavRouter = () => {
       <Router id="ws-page-content-router">
         {Object.entries(routes)
           .map(([path, { Component, title, sources, katacodaLayout }]) => Component
-            ? <AppRoute key={path} path={path} default={path === '/404'} child={<Component />} katacodaLayout={katacodaLayout} />
-            : <AppRoute key={path} path={path + '/*'} child={
-                <MDXTemplate
-                  path={path}
-                  title={title}
-                  sources={sources}
-                />
-              } katacodaLayout={katacodaLayout} />
+            ? <AppRoute
+                key={path}
+                path={path}
+                default={path === '/404'}
+                child={<Component />}
+                katacodaLayout={katacodaLayout}
+              />
+            : <AppRoute
+                key={path}
+                path={path + '/*'}
+                child={
+                  <MDXTemplate
+                    path={path}
+                    title={title}
+                    sources={sources}
+                  />
+                }
+                katacodaLayout={katacodaLayout}
+              />
           )
         }
       </Router>

packages/theme-patternfly-org/package.json

@@ -1,7 +1,7 @@
 {
   "name": "theme-patternfly-org",
   "description": "A unified PatternFly and PatternFly-React theme.",
-  "version": "0.2.11",
+  "version": "0.3.0",
   "author": "Red Hat",
   "license": "MIT",
   "bin": {

packages/theme-patternfly-org/scripts/tsDocgen.js

@@ -17,6 +17,11 @@ const annotations = [
     regex: /@beta/,
     name: 'beta',
     type: 'Boolean'
+  },
+  {
+    regex: /@propType\s+(.*)/,
+    name: 'type',
+    type: 'String'
   }
 ];
 
@@ -26,7 +31,9 @@ function addAnnotations(prop) {
       const match = prop.description.match(regex);
       if (match) {
         prop.description = prop.description.replace(regex, '').trim();
-        prop[name] = match[2] || match[1] || true;
+        if (name) {
+          prop[name] = match[2] || match[1] || true;
+        }
       }
     })
   }
@@ -136,10 +143,12 @@ function tsDocgen(file) {
       props: Object.entries(parsed.props || {})
         .map(normalizeProp)
         .map(addAnnotations)
+        .filter(prop => !prop.hide)
         .sort((p1, p2) => p1.name.localeCompare(p2.name))
     }));
 }
 
 module.exports = {
   tsDocgen
 };
+