Testing features (#202)

* add demonstration in dummy-data of missing readme

* pass full pkgjson info down to package:home templates

* convert to using changesets v2

* Actually udpate to v2 of changesets

* Add changeset workflows

Author: Noviny

.changeset/config.js

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "./getChangelogEntries",
+  "commit": false,
+  "linked": [],
+  "access": "public"
+}

.changeset/config.json

@@ -0,0 +1,28 @@
+const getReleaseLine = async changeset => {
+  const [firstLine, ...futureLines] = changeset.summary
+    .split('\n')
+    .map(l => l.trimRight());
+
+  return `- ${changeset.commit}: ${firstLine}\n${futureLines
+    .map(l => `  ${l}`)
+    .join('\n')}`;
+};
+
+const getDependencyReleaseLine = async (changesets, dependenciesUpdated) => {
+  if (dependenciesUpdated.length === 0) return '';
+
+  const changesetLinks = changesets.map(
+    changeset => `- Updated dependencies [${changeset.commit}]:`,
+  );
+
+  const updatedDepenenciesList = dependenciesUpdated.map(
+    dependency => `  - ${dependency.name}@${dependency.version}`,
+  );
+
+  return [...changesetLinks, ...updatedDepenenciesList].join('\n');
+};
+
+module.exports = {
+  getReleaseLine,
+  getDependencyReleaseLine,
+};

.changeset/getChangelogEntries.js

@@ -0,0 +1,14 @@
+name: Changeset Check
+
+on: pull_request
+
+jobs:
+  check:
+    name: Changeset Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Comment on PR
+        uses: changesets/check-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/changeset-check.yml

@@ -0,0 +1,30 @@
+name: Version
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@master
+
+      - name: Setup Node.js 10.x
+        uses: actions/setup-node@master
+        with:
+          version: 10.x
+
+      - name: Install Yarn
+        run: npm install --global yarn
+
+      - name: Install Dependencies
+        run: yarn
+
+      - name: Create Release Pull Request
+        uses: changesets/action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/changeset-version.yml

@@ -82,7 +82,7 @@
     "@babel/preset-typescript": "^7.3.3",
     "@babel/runtime": "^7.4.3",
     "@babel/runtime-corejs2": "^7.4.3",
-    "@changesets/cli": "^1.3.0",
+    "@changesets/cli": "^2.0.1",
     "@emotion/core": "^10.0.9",
     "@emotion/styled": "^10.0.9",
     "@emotion/styled-base": "^10.0.10",

package.json

@@ -0,0 +1,3 @@
+module.exports = () => ({
+  sortOrder: ['special-usecase', '*'],
+});

packages/website/dummy-data/complete-config-project/otherpackages/package-no-readme/docs/docs.config.js

@@ -0,0 +1,5 @@
+import React from 'react';
+
+const Subexample = () => <h1>Hello, from a subexample inside docs/</h1>;
+
+export default Subexample;

packages/website/dummy-data/complete-config-project/otherpackages/package-no-readme/docs/examples.js

@@ -0,0 +1,26 @@
+```
+Give examples
+```
+
+### Installing
+
+A step by step series of examples that tell you how to get a development env running
+
+Say what the step will be
+
+```
+Give the example
+```
+
+And repeat
+
+```
+until finished
+```
+
+End with an example of getting some data out of the system or using it for a little demo
+
+## Versioning
+
+We use [Vertool](http://semver.org/) for versioning. For the versions available, see the
+[tags on this repository](https://github.com/your/project/tags).

packages/website/dummy-data/complete-config-project/otherpackages/package-no-readme/docs/extended-info.md

@@ -0,0 +1,19 @@
+## Running the tests
+
+Explain how to run the automated tests for this system
+
+### Break down into end to end tests
+
+Explain what these tests test and why
+
+```
+Give an example
+```
+
+### And coding style tests
+
+Explain what these tests test and why
+
+## Deployment
+
+Add additional notes about how to deploy this on a live system

packages/website/dummy-data/complete-config-project/otherpackages/package-no-readme/docs/special-usecase.md

@@ -0,0 +1,6 @@
+import React from 'react';
+
+const name = 'Example 1 package 2';
+const Example1 = () => <h1>Hello, {name}</h1>;
+
+export default Example1;

packages/website/dummy-data/complete-config-project/otherpackages/package-no-readme/examples/example1.js

@@ -0,0 +1,6 @@
+import React from 'react';
+
+const name = 'Example 2 package 2';
+const Example2 = () => <h1>Hello, {name}</h1>;
+
+export default Example2;

packages/website/dummy-data/complete-config-project/otherpackages/package-no-readme/examples/example2.js

@@ -0,0 +1,6 @@
+import React from 'react';
+
+const name = 'Example 3 package 2';
+const Example3 = () => <h1>Hello, {name}</h1>;
+
+export default Example3;

packages/website/dummy-data/complete-config-project/otherpackages/package-no-readme/examples/example3.js

@@ -0,0 +1,14 @@
+{
+  "name": "package-no-readme",
+  "version": "1.0.0",
+  "description": "This mock package has no readme",
+  "main": "index.js",
+  "keywords": [],
+  "author": "Test2",
+  "license": "",
+  "dependencies": {
+    "react": "^16.7.0",
+    "react-dom": "^16.7.0",
+    "styled-components": "^4.1.3"
+  }
+}

packages/website/dummy-data/complete-config-project/otherpackages/package-no-readme/package.json

@@ -0,0 +1,7 @@
+import React from 'react';
+
+const Subexample = () => <h1>Hello, from a subexample</h1>;
+
+export default Subexample;
+
+export const AnotherExample = () => <div>another example</div>;

packages/website/dummy-data/complete-config-project/otherpackages/package-no-readme/src/examples.js

@@ -0,0 +1,6 @@
+import React from 'react';
+
+const name = 'Test Package 2';
+const Element = <h1>Hello, {name}</h1>;
+
+export default Element;

packages/website/dummy-data/complete-config-project/otherpackages/package-no-readme/src/index.js

@@ -54,6 +54,9 @@ export interface PackageInfo {
   examples: ExampleItem[];
   // Tree of inner package examples
   subExamples: ExampleTreeNode[];
+  pkg: {
+    [key: string]: any;
+  };
 }
 
 // A group of docs to be shown on the top level of the website

packages/website/src/pipeline/stages/common/project-info.ts

@@ -171,6 +171,7 @@ Object {
             "must-read",
           ],
           "packageName": "package one",
+          "pkg": Object {},
         },
         "websitePath": "packages/package-1",
       },

packages/website/src/pipeline/stages/generate-website-info/__snapshots__/test.ts.snap

@@ -19,9 +19,11 @@ const mockData: PackageInfo[] = [
     docs: [],
     examples: [],
     subExamples: [],
+    pkg: {},
   },
 
   {
+    pkg: {},
     id: 'package-2',
     name: 'Package Two',
     packageFields: {},
@@ -90,6 +92,7 @@ describe('Package website info generator', () => {
         customField1: 'foo',
         customField2: 'bar',
         metaField1: 'baz',
+        pkg: {},
       },
       meta: { title: 'Package 1' },
     });
@@ -147,6 +150,7 @@ describe('Package website info generator', () => {
   it('processes docs website information', () => {
     const mockDataWithDocs = [
       {
+        pkg: {},
         id: 'package-1',
         name: 'Package One',
         packageFields: {},
@@ -190,6 +194,7 @@ describe('Package website info generator', () => {
   it('outputs top level examples', () => {
     const mockDataWithExamples = [
       {
+        pkg: {},
         id: 'package-1',
         name: 'Package One',
         packageFields: {},
@@ -226,6 +231,7 @@ describe('Package website info generator', () => {
         readmeMeta: {},
         docs: [],
         examples: [],
+        pkg: {},
         subExamples: [
           {
             id: 'sub-examples-group-1',

packages/website/src/pipeline/stages/generate-website-info/generate-package-info.test.ts

@@ -77,6 +77,7 @@ const generatePackageInfo = (
       ...pkg.packageFields,
       customPackageFields: Object.keys(pkg.packageFields),
       ...pkg.readmeMeta,
+      pkg: pkg.pkg,
     },
     meta: { title: titleCase(pkg.id) },
   };

packages/website/src/pipeline/stages/generate-website-info/generate-package-info.ts

@@ -60,6 +60,7 @@ export const singlePackageData: PackageInfo[] = [
         ],
       },
     ],
+    pkg: {},
   },
 ];
 

packages/website/src/pipeline/stages/generate-website-info/sample-data.ts

@@ -238,6 +238,7 @@ export default async ({
         docs: getDocsInfo(path.join(directoryPath, 'docs')) || [],
         examples,
         subExamples,
+        pkg: packageDefinition,
       };
 
       return packageInfo;