Skip to content

Commit

Permalink
Automatically update github pages via the CI
Browse files Browse the repository at this point in the history
  • Loading branch information
lovasoa committed Oct 11, 2020
1 parent edb9aa6 commit 6e7ec33
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 30 deletions.
11 changes: 11 additions & 0 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,14 @@ jobs:
with: {name: dist, path: dist}
- name: test
run: npm ci && npm test
- name: generate documentation
# We need the symbolic links to avoid breaking old URLs
run: npm run doc && mkdir -p documentation/class && ln -s documentation/* documentation/class/
- name: Update github pages
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
uses: JamesIves/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: "." # The folder the action should deploy.
CLEAN: false # Automatically remove deleted files from the deploy branch
Empty file added .nojekyll
Empty file.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# SQLite compiled to JavaScript <img src="https://user-images.githubusercontent.com/552629/76405509-87025300-6388-11ea-86c9-af882abb00bd.png" width="40" height="40" />
<img src="https://user-images.githubusercontent.com/552629/76405509-87025300-6388-11ea-86c9-af882abb00bd.png" width="40" height="40" />

# SQLite compiled to JavaScript

[![CI status](https://github.com/sql-js/sql.js/workflows/CI/badge.svg)](https://github.com/sql-js/sql.js/actions)
[![npm](https://img.shields.io/npm/v/sql.js)](https://www.npmjs.com/package/sql.js)
Expand Down Expand Up @@ -271,7 +273,9 @@ Although asm.js files were distributed as a single Javascript file, WebAssembly



## Versions of sql.js included in the [distributed artifacts](https://github.com/sql-js/sql.js/releases/latest)
## Versions of sql.js included in the distributed artifacts
You can always find the latest published artifacts on https://github.com/sql-js/sql.js/releases/latest.

For each [release](https://github.com/sql-js/sql.js/releases/), you will find a file called `sqljs.zip` in the *release assets*. It will contain:
- `sql-wasm.js` : The Web Assembly version of Sql.js. Minified and suitable for production. Use this. If you use this, you will need to include/ship `sql-wasm.wasm` as well.
- `sql-wasm-debug.js` : The Web Assembly, Debug version of Sql.js. Larger, with assertions turned on. Useful for local development. You will need to include/ship `sql-wasm-debug.wasm` if you use this.
Expand Down
49 changes: 21 additions & 28 deletions index.html
Original file line number Diff line number Diff line change
@@ -1,28 +1,21 @@
<!doctype html>
<html>
<head>
<title>sql.js</title>
</head>

<body>
<h1>sql.js</h1>

<h2>Examples</h2>

<ol>
<li><a href="./examples/GUI">Online SQL Interpreter</a> Full featured Sqlite Interpreter running in your browser.</li>
<li><a href="./examples/repl.html">Online SQL read eval print loop</a> simple SQLite REPL </li>
<li><a href="./examples/persistent.html">Persistence</a> Persisting data</li>
<li><a href="./examples/requireJS.html">RequireJS</a> Load sql.js asynchronously using <a href="https://requirejs.org/">RequireJs</a></li>
<li><a href="./examples/simple.html">Simple Example</a> Demonstrates prepare,getAsObject, and other SQL.js methods. </li>
</ol>

Note: To run these examples locally, see <a href="./examples/">./examples/readme.md</a>

<h2>Source</h2>

<p><a href="https://github.com/sql-js/sql.js">Source on Github</a></p>

</body>
</html>

<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<title>sql.js</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description"
content="sql.js is an SQL library for javascript containing a version of SQLite compiled for the web.">
<meta name="viewport"
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
</head>

<body>
<div id="app"></div>
<script>window.$docsify = { name: 'SQL.js', repo: '' }</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
</body>

</html>

0 comments on commit 6e7ec33

Please sign in to comment.