Skip to content

Commit

Permalink
Init library react-xtermjs
Browse files Browse the repository at this point in the history
  • Loading branch information
RemiBonnet committed Jul 5, 2024
1 parent 9708225 commit d0a0c40
Show file tree
Hide file tree
Showing 13 changed files with 8,735 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/npm-published.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

name: Upload NPM Package

on:
workflow_run:
workflows: ['Release']
types:
- completed

jobs:
deploy:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up Node
uses: actions/setup-node@v2
with:
node-version: '20.x'
registry-url: 'https://registry.npmjs.org'
- name: Install dependencies
run: npm ci
- name: Publish package
run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
36 changes: 36 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Release
on:
push:
branches:
- main

permissions:
contents: read # for checkout

jobs:
release:
name: Release
runs-on: ubuntu-latest
permissions:
contents: write # to be able to publish a GitHub release
issues: write # to be able to comment on released issues
pull-requests: write # to be able to comment on released pull requests
id-token: write # to enable use of OIDC for npm provenance
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 'lts/*'
- name: Install dependencies
run: npm clean-install
- name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
run: npm audit signatures
- name: Release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: npx semantic-release
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
dist
example
Empty file added .npmignore
Empty file.
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dist
7 changes: 7 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"semi": false,
"tabWidth": 2,
"printWidth": 120,
"singleQuote": true,
"trailingComma": "es5"
}
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<h1>XTerm.js for React</h1>

<p>
A React library to use the powerful of <a href="https://github.com/xtermjs/xterm.js" target="_blank">Xterm.js</a>
</p>
<p>
<a href="https://www.npmjs.com/package/react-xtermjs"><img alt="npm version" src="https://img.shields.io/npm/v/react-xtermjs.svg"></a>
<a href="https://www.npmjs.com/package/react-xtermjs"><img alt="npm download" src="https://img.shields.io/npm/dw/react-xtermjs"></a>
</p>
<br />

## Getting Started

### Installation

NPM:

npm install react-xtermjs

Yarn:

yarn add react-xtermjs

<br />
<hr />

<p>react-xtermjs is initiated and maintained by <a href="https://qovery.com" target="blank">Qovery</a>.</p>
Loading

0 comments on commit d0a0c40

Please sign in to comment.