Skip to content

Commit

Permalink
Merge branch 'main' into irv2
Browse files Browse the repository at this point in the history
  • Loading branch information
junhaoliao authored Nov 11, 2024
2 parents 2df1e9c + a168a2a commit e0bdb68
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 2 deletions.
53 changes: 53 additions & 0 deletions .github/workflows/deploy-gh-pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: "deploy-github-pages"

on:
push:
branches: ["main"]

permissions: {}

concurrency:
group: "${{github.workflow}}-${{github.ref}}"

# Cancel in-progress jobs for efficiency
cancel-in-progress: true

jobs:
build:
runs-on: "ubuntu-latest"
steps:
- uses: "actions/checkout@v4"
with:
submodules: "recursive"

- uses: "actions/setup-node@v4"
with:
node-version: "22"
cache: "npm"
cache-dependency-path: "./package-lock.json"

- run: "npm install"

- run: "npm run build"

- name: "Upload static files as artifact"
uses: "actions/upload-pages-artifact@v3"
with:
path: "./dist"

deploy:
needs: "build"
permissions:
# To deploy to Pages
pages: "write"

# To request a JWT from GitHub for certifying the origin of the deployment
id-token: "write"
runs-on: "ubuntu-latest"
environment:
name: "github-pages"
url: "${{steps.deployment.outputs.page_url}}"
steps:
- name: "Deploy to GitHub Pages"
id: "deployment"
uses: "actions/deploy-pages@v4"
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,16 @@ supports [CLP][clp-repo]'s compressed log files (IR streams) and JSON log files.
The viewer can be used to navigate the log file, filter by log level, view the
logs with syntax highlighting, and generate direct links to specific log events.

To start a local server for accessing the application locally, refer to our
See the [online demo](#online-demo) section to try out the log viewer on a
sample log file. To set up a local server, follow the
[build guide](docs/dev-guide/building.md).

See the [features in development](#features-in-development) section for upcoming
features.

# Online Demo

* A demo of the log viewer can be found at https://yscope.com/log-viewer
* A demo of the log viewer can be found [here][online-demo].
* The demo loads a Hadoop YARN log file from the [hive-24hrs] log dataset.
* More info on the dataset and other datasets can be found [here][datasets].
* To open an IR stream, drag and drop it onto the log viewer or use the open
Expand Down Expand Up @@ -78,6 +79,7 @@ See the docs in our [developer guide](docs/dev-guide).
[log4j1-appenders]: https://github.com/y-scope/log4j1-appenders
[logback-appenders]: https://github.com/y-scope/logback-appenders
[monaco-editor]: https://microsoft.github.io/monaco-editor/
[online-demo]: https://y-scope.github.io/yscope-log-viewer/?filePath=https://yscope.s3.us-east-2.amazonaws.com/sample-logs/yarn-ubuntu-resourcemanager-ip-172-31-17-135.log.1.clp.zst
[report-bug]: https://github.com/y-scope/yscope-log-viewer/issues/new?labels=bug&template=bug-report.yml
[request-feature]: https://github.com/y-scope/yscope-log-viewer/issues/new?labels=enhancement&template=feature-request.yml
[zulip]: https://yscope-clp.zulipchat.com/
Expand Down

0 comments on commit e0bdb68

Please sign in to comment.