Merge pull request #1 from grammarly/gh-actions

akryvomaz · web-flow · commit c24b8feeb8e7 · 2021-04-26T18:11:16.000+03:00
add GitHub actions
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,27 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Branch name
+        id: branch_name
+        run: echo ::set-output name=TARBALL::grammarly-embrace-${GITHUB_REF#refs/tags/}.tgz
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - run: yarn install
+      - run: yarn build
+      - run: yarn test
+      - run: yarn pack
+      - name: Upload binaries to release
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: ./${{ steps.branch_name.outputs.TARBALL }}
+          asset_name: ${{ steps.branch_name.outputs.TARBALL }}
+          tag: ${{ github.ref }}
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,24 @@
+name: Tests
+
+on: [pull_request]
+
+jobs:
+  tests:
+    name: Run tests
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: yarn install
+    - run: yarn build
+    - run: yarn test
+      env:
+        CI: true
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+.DS_Store
 .idea
 *.log
 *.lock
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Embrace
 
-Typesafe, declarative, and composable UI engine on top of [React](https://reactjs.org/).
+Typesafe, declarative, and composable UI engine on top of [React](https://reactjs.org/) and [Focal](https://github.com/grammarly/focal).
 
 - Detect breaking changes in components with the static type system.
 - Clear separation between UI and the logic.
@@ -25,7 +25,7 @@ import { Flow, UI } from '@grammarly/embrace'
  *   <Body>
  * </Grid>
  */
-const mainGrid = UI.Grid.make<'header' | 'body', never, never>(({ slots }) => (
+const mainGrid = UI.Grid.make<'header' | 'body'>(({ slots }) => (
   <div className="main">
     {slots.header}
     {slots.body}
@@ -41,7 +41,7 @@ const Body = UI.Node.make<{ readonly content: string }, never>(({ state }) => (
 export const bodyFlow: Flow.For<typeof Body> = Rx.startWith({ content: 'Hello, World!' })
 
 // Header component. Neither consumes state or emits events
-const Header = UI.Node.make<never, never>(() => <header className="header">Welcome</header>)
+const Header = UI.Node.make(() => <header className="header">Welcome</header>)
 
 // Produce a component by composing `mainGrid` with `Header` and `Body`
 export const Main = UI.Knot.make(mainGrid, { header: Header, body: Body })
@@ -101,6 +101,10 @@ const App: React.FC = () => UI.mount(NewMain, newMainFlow)
 ReactDOM.render(<App />, document.getElementById('root'))
 ```
 
+## Project Status
+
+Embrace is an experimental prototype. Breaking changes may occur up to 1.0.0 is released.
+
 ## WHY?
 
 With the applications growing with features and code-base, more and more developers are looking for ways to re-use the code between them.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@grammarly/embrace",
   "version": "0.1.0",
-  "description": "Typesafe, declarative, and composable UI engine on top of React",
+  "description": "Typesafe, declarative, and composable UI engine on top of React and Focal",
   "main": "cjs/index.js",
   "module": "esm/index.js",
   "es2015": "esm2015/index.js",

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+.DS_Store`
`1`	`2`	`.idea`
`2`	`3`	`*.log`
`3`	`4`	`*.lock`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@grammarly/embrace",`
`3`	`3`	`"version": "0.1.0",`
`4`		`- "description": "Typesafe, declarative, and composable UI engine on top of React",`
	`4`	`+ "description": "Typesafe, declarative, and composable UI engine on top of React and Focal",`
`5`	`5`	`"main": "cjs/index.js",`
`6`	`6`	`"module": "esm/index.js",`
`7`	`7`	`"es2015": "esm2015/index.js",`