Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Phasing out the old web package #572

Merged
merged 2 commits into from
Apr 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 0 additions & 44 deletions .github/workflows/visual-ci-new.yaml

This file was deleted.

33 changes: 19 additions & 14 deletions .github/workflows/visual-ci.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Visual Testing Pipeline
name: Web Package Visual Testing Pipeline

on:
pull_request:
Expand All @@ -14,26 +14,31 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3

- name: Use Node.js 16
uses: actions/setup-node@v1
- name: Use Node.js 18
uses: actions/setup-node@v3
with:
node-version: "16.x"
node-version: "18.x"

- name: Use lerna
run: npm install -g [email protected]

- name: Bootstrap
run: lerna bootstrap --no-ci

- name: Visual Test

- name: Visual Tests
timeout-minutes: 30
run: |
cd ./packages/web
npm test

- name: Upload test screenshots
uses: actions/upload-artifact@v2
cd ./packages/web
npm install
npx playwright install chromium firefox
npm run build
npm test

- uses: actions/upload-artifact@v3
if: always()
with:
name: playwright screenshots and downloads
path: packages/web/test_results
name: playwright-report
path: ./packages/web/playwright-report/
retention-days: 30
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ eslint-results.sarif

# junit test results
junit-tests.xml
packages/web-new/test-results
packages/web-new/playwright-report
packages/web/test-results
packages/web/playwright-report
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,19 @@ Reusable packages:
End Product Packages:

- [cli](./packages/cli/): The CLI package wraps the above packages in a way they can be used from the command line. Additionally, it allows the functionalities of the other packages to be executed on a set of TDs. [NPM](https://www.npmjs.com/package/@thing-description-playground/cli).
- [web](./packages/web/): The Web package wraps the above packages in a way they can be used from a browser interface. You can host/adapt your own browser version of the playground. It is online at [http://plugfest.thingweb.io/playground/](http://plugfest.thingweb.io/playground/)[NPM](https://www.npmjs.com/package/@thing-description-playground/web).
- [web](./packages/web/): The Web package wraps the above packages in a way they can be used from a browser interface. You can host/adapt your own browser version of the playground. It is online at [https://playground.thingweb.io/](https://playground.thingweb.io/)[NPM](https://www.npmjs.com/package/@thing-description-playground/web).

## Examples

Examples are included in the [core](./packages/core/examples) and in the [examples folder](./examples) at the root of the project.

## Browser-based Thing Description Validation

- Online: It is hosted [here](http://plugfest.thingweb.io/playground/)
- Online: It is hosted [here](https://playground.thingweb.io/)

- Simply paste a TD in the text field and click validate
- Safari browser has unexpected behavior with JSON-LD documents
- If you loose your internet connection when validating JSON-LD validation will fail since it tries to access the documents under `@context` (can be turned off)
- If you lose your internet connection when validating JSON-LD validation will fail since it tries to access the documents under `@context` (can be turned off)

- Offline/OnPremise: by hosting the `web` yourself. Therefore, please deliver the "index.html" file with a web-server.

Expand Down Expand Up @@ -94,4 +94,3 @@ All packages are licensed under the Eclipse Public License v. 2.0. You find a co
## Adapting Licenses

One can use the VS Code plugin at <https://marketplace.visualstudio.com/items?itemName=angelo-breuer.license-header-manager> to updating the copyright fields on top of each file.

2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"packages": ["packages/*"],
"version": "independent",
"ignore": ["packages/web-new"]
"ignore": ["packages/web"]
}
135 changes: 0 additions & 135 deletions packages/web-new/README.md

This file was deleted.

Loading
Loading