Skip to content

Commit

Permalink
fix broken links and ci (#142)
Browse files Browse the repository at this point in the history
  • Loading branch information
rannn505 authored Nov 8, 2021
1 parent 1164928 commit 328f940
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 29 deletions.
10 changes: 7 additions & 3 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: CI

on:
push:
branches: [master, next]
branches: [master]

jobs:
build:
Expand All @@ -11,7 +11,7 @@ jobs:
os: [ubuntu-latest, macos-latest, windows-latest]
node: [lts/dubnium, lts/*]
runs-on: ${{ matrix.os }}
# [NOTE] powershell is already install on GitHub-hosted runners
# Bash & PowerShell are already installed on GitHub-hosted runners
# https://help.github.com/en/actions/reference/software-installed-on-github-hosted-runners

steps:
Expand All @@ -24,8 +24,12 @@ jobs:
node-version: ${{ matrix.node }}
registry-url: 'https://registry.npmjs.org'

- run: npm -v
# Latest npm is needed for workspaces capabilities
- name: Install npm latest
run: npm install -g npm

- run: npm ci

- run: npm run format:check
- run: npm run lint:check
- run: npm test
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img alt="child-shell" src="https://raw.githubusercontent.com/rannn505/node-powershell/node-shell/logo/logo.svg?sanitize=true" width="128">
<img alt="child-shell" src="https://raw.githubusercontent.com/rannn505/child-shell/master/icon/icon.svg?sanitize=true" width="128">
</p>
<h3 align="center"> Child Shell </h3>
<p align="center"> Node.js bindings 🔗 for shell </p>
Expand All @@ -15,28 +15,28 @@

<p align="center">
<a href="">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/rannn505/node-powershell/CI?style=flat-square">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/rannn505/child-shell/CI?style=flat-square">
</a>
<a href="">
<!-- <a href="">
<img alt="Coverage" src="">
</a> -->
<a href="https://jestjs.io/">
<img alt="Jest" src="https://img.shields.io/badge/tested_with-jest-99424f.svg?style=flat-square">
</a>
<a href="https://npm-stat.com/charts.html?package=child-shell">
<img alt="NPM Downloads" src="https://img.shields.io/npm/dt/child-shell.svg?style=flat-square">
</a>
<a href="https://github.com/rannn505/node-powershell/stargazers">
<img alt="GitHub Stars" src="https://img.shields.io/github/stars/rannn505/node-powershell?style=social">
<a href="https://prettier.io/">
<img alt="Prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square">
</a>
</p>

<p align="center">
<a href="https://jestjs.io/">
<img alt="Jest" src="https://img.shields.io/badge/tested_with-jest-99424f.svg?style=flat-square">
<a href="https://npm-stat.com/charts.html?package=child-shell">
<img alt="NPM Downloads" src="https://img.shields.io/npm/dt/child-shell.svg?style=flat-square">
</a>
<a href="https://prettier.io/">
<img alt="Prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square">
<a href="https://github.com/rannn505/child-shell/stargazers">
<img alt="GitHub Stars" src="https://img.shields.io/github/stars/rannn505/child-shell?style=social">
</a>
<a href="https://github.com/rannn505/node-powershell/blob/node-shell/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/rannn505/node-powershell?color=%23000000&style=flat-square">
<a href="https://github.com/rannn505/child-shell/blob/master/LICENSE.md">
<img alt="License" src="https://img.shields.io/github/license/rannn505/child-shell?color=%23000000&style=flat-square">
</a>
</p>

Expand Down Expand Up @@ -72,15 +72,15 @@ Learn about using [child-shell on the official site!](https://<>)
- [Configuring child-shell](https://<>/docs/configuration)
- [Useful Tips](https://<>/docs/tips)
- [API Reference](https://<>/docs/en/api)
- Shell Libraries:
- Shell packages:
- [node-bash](/packages/node-bash)
- [node-powershell](/packages/node-powershell)

## Contributing

Development of **child-shell** happens transparently on its [GitHub repo](https://github.com/rannn505/child-shell).<br/>
Read the [contributing guide](CONTRIBUTING.md) to learn how to propose bugfixes and improvements, and how to build and test your changes.<br/>
Future plans for **child-shell** are visible on its [board](https://github.com/rannn505/child-shell/projects/1).
Future plans for **child-shell** are visible on its [board](https://github.com/rannn505/child-shell/projects/<>).
These plans are subject to frequent changes, and will be greatly affected by your feedback.

## License
Expand Down
8 changes: 4 additions & 4 deletions packages/node-bash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Node.js binding for Bash
[![NPM Version](https://img.shields.io/npm/v/node-powershell.svg?style=flat-square)](https://www.npmjs.com/package/node-powershell) [![NPM Downloads](https://img.shields.io/npm/dt/node-powershell.svg?style=flat-square)](https://npm-stat.com/charts.html?package=node-powershell) [![Coveralls](https://img.shields.io/coveralls/rannn505/node-powershell.svg?style=flat-square)](https://coveralls.io/github/rannn505/node-powershell)
[![NPM Version](https://img.shields.io/npm/v/node-bash.svg?style=flat-square)](https://www.npmjs.com/package/node-bash) [![NPM Downloads](https://img.shields.io/npm/dt/node-bash.svg?style=flat-square)](https://npm-stat.com/charts.html?package=node-bash)

## Installation

Expand All @@ -14,11 +14,11 @@ $ yarn add node-bash
## Usage

```javascript
import { $ } from 'node-bash';
$`echo "hello from Bash"`;
import { Bash } from 'node-bash';
Bash.$`echo "hello from Bash"`;
```

> See **child-shell** [documentation](https:/<>) and [playground](/packages/playground/index.ts) for more use cases
> See **child-shell** [documentation](https:/<>) and [playground](https://github.com/rannn505/child-shell/blob/master/playground/index.ts) for more use cases
## Resources

Expand Down
2 changes: 1 addition & 1 deletion packages/node-bash/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "node-bash",
"version": "5.0.0",
"version": "5.0.1",
"description": "Node.js binding for Bash",
"author": "Ran Cohen <[email protected]>",
"homepage": "https://github.com/rannn505/child-shell/tree/master/packages/node-bash#readme",
Expand Down
8 changes: 4 additions & 4 deletions packages/node-powershell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Node.js binding for PowerShell
[![NPM Version](https://img.shields.io/npm/v/node-powershell.svg?style=flat-square)](https://www.npmjs.com/package/node-powershell) [![NPM Downloads](https://img.shields.io/npm/dt/node-powershell.svg?style=flat-square)](https://npm-stat.com/charts.html?package=node-powershell) [![Coveralls](https://img.shields.io/coveralls/rannn505/node-powershell.svg?style=flat-square)](https://coveralls.io/github/rannn505/node-powershell)
[![NPM Version](https://img.shields.io/npm/v/node-powershell.svg?style=flat-square)](https://www.npmjs.com/package/node-powershell) [![NPM Downloads](https://img.shields.io/npm/dt/node-powershell.svg?style=flat-square)](https://npm-stat.com/charts.html?package=node-powershell)

## Installation

Expand All @@ -14,11 +14,11 @@ $ yarn add node-powershell
## Usage

```javascript
import { $ } from 'node-powershell';
$`echo "hello from PowerShell"`;
import { PowerShell } from 'node-powershell';
PowerShell.$`echo "hello from PowerShell"`;
```

> See **child-shell** [documentation](https:/<>) and [playground](/packages/playground/index.ts) for more use cases
> See **child-shell** [documentation](https:/<>) and [playground](https://github.com/rannn505/child-shell/blob/master/playground/index.ts) for more use cases
## Resources

Expand Down
2 changes: 1 addition & 1 deletion packages/node-powershell/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "node-powershell",
"version": "5.0.0",
"version": "5.0.1",
"description": "Node.js binding for PowerShell",
"author": "Ran Cohen <[email protected]>",
"homepage": "https://github.com/rannn505/child-shell/tree/master/packages/node-powershell#readme",
Expand Down

0 comments on commit 328f940

Please sign in to comment.