Skip to content

Commit

Permalink
docs: Post alpha release update on runners & README (#356)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md

* Update release.yml

* Update pull_request.yml

* Update gh-pages.yml

* Update semantic_release_lint.yml

* Update pull_request.yml

* Update release.yml
  • Loading branch information
matmalkowski authored Oct 2, 2024
1 parent 47717a2 commit decf732
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 65 deletions.
32 changes: 16 additions & 16 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,27 @@ name: deploy-docs
on:
push:
branches:
- alpha # replace with master once merged
- alpha # replace with master once merged

# install dependencies, build, and push to `gh-pages`
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
persist-credentials: false
- uses: actions/checkout@v3
with:
persist-credentials: false

- name: Install and build
working-directory: docs
run: |
yarn
yarn build
- name: Install and build
working-directory: docs
run: |
yarn
yarn build
- name: Deploy to gh-pages
uses: JamesIves/github-pages-deploy-action@3.7.1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: docs/build
CLEAN: true
- name: Deploy to gh-pages
uses: JamesIves/github-pages-deploy-action@v4
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: docs/build
CLEAN: true
58 changes: 30 additions & 28 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,33 @@ name: Validate Pull Request
on: [pull_request]

jobs:
run:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [12.x]
env:
CI: true
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- run: sudo apt-get install xvfb
- name: yarn install, build & tests
run: |
yarn install --frozen-lockfile
xvfb-run --auto-servernum yarn test
env:
CI: true
- name: Cleanup xvfb pidx
uses: bcomnes/cleanup-xvfb@v1
- name: Install and build docs
working-directory: docs
run: |
yarn
yarn build
run:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [12.x] # Updated to use more recent LTS versions

steps:
- uses: actions/checkout@v3

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}

- run: sudo apt-get install xvfb

- name: yarn install, build & tests
run: |
yarn install --frozen-lockfile
xvfb-run --auto-servernum yarn test
- name: Cleanup xvfb pidx
uses: bcomnes/cleanup-xvfb@v1

- name: Install and build docs
working-directory: docs
run: |
yarn
yarn build
8 changes: 4 additions & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ on:
jobs:
release:
name: Release
runs-on: ubuntu-18.04
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup Node.js
uses: actions/setup-node@v1
uses: actions/setup-node@v3
with:
node-version: 12
node-version: '12'
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Build the package
Expand Down
25 changes: 14 additions & 11 deletions .github/workflows/semantic_release_lint.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
name: 'Pull Request SemVer lint'

on:
pull_request_target:
types:
- opened
- edited
- synchronize
pull_request_target:
types:
- opened
- edited
- synchronize

jobs:
main:
runs-on: ubuntu-latest
steps:
- uses: amannn/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
main:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- uses: amannn/action-semantic-pull-request@v3
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
🚧 THIS IS **ALPHA** version of the library - the API still might change 🚧

# electron-redux

Electron-Redux is an Redux Store Enhancer that helps you loosely synchronize the redux stores in multiple electron processes.

When working with Electron, using Redux poses couple of problems, since main and renderer processes are isolated and IPC is a single way of communication between them. This library, enables you to register all your Redux stores in the main & renderer process, and enable cross-process action dispatching & _loose_ store synchronization.

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/klarna/electron-redux/Release)](https://github.com/klarna/electron-redux/actions?query=workflow%3ARelease)
[![npm (tag)](https://img.shields.io/npm/v/electron-redux/alpha)](https://www.npmjs.com/package/electron-redux/)
[![npm (tag)](https://img.shields.io/npm/v/electron-redux)](https://www.npmjs.com/package/electron-redux/)
[![npm](https://img.shields.io/npm/dm/electron-redux)](https://www.npmjs.com/package/electron-redux/)
[![npm bundle size (version)](https://img.shields.io/bundlephobia/minzip/electron-redux/alpha)](https://bundlephobia.com/result?p=electron-redux)
[![npm bundle size (version)](https://img.shields.io/bundlephobia/minzip/electron-redux)](https://bundlephobia.com/result?p=electron-redux)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

## Installation

```sh
# with yarn
yarn add electron-redux@alpha
yarn add electron-redux

# with npm
npm install electron-redux@alpha
npm install electron-redux
```

For more details, please see [the Installation docs page](#todo).
Expand Down

0 comments on commit decf732

Please sign in to comment.