Skip to content

Commit

Permalink
chore(package): move to omicronenergy
Browse files Browse the repository at this point in the history
  • Loading branch information
ca-d committed Apr 22, 2024
1 parent 0135b03 commit 8a4809c
Show file tree
Hide file tree
Showing 7 changed files with 140 additions and 146 deletions.
30 changes: 13 additions & 17 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,34 +1,30 @@
name: Bundle and Deploy
name: Deploy
on:
push:
branches:
- main

jobs:
build-and-deploy:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Use Node.js 16
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: '16'

- name: Configure git
run: |
git config user.name "GitHubActions"
git config user.email "<[email protected]>"
node-version: '20'

- name: Install dependencies
run: npm ci

- name: Bundle
run: npm run-script bundle

- name: Build
run: npm run bundle

- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: dist # The folder the action should deploy.
- name: Deploy
run: |
git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
npx gh-pages -d dist -u "github-actions <[email protected]>"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2 changes: 1 addition & 1 deletion .github/workflows/test-on-pr-branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: '16'
node-version: '20'

- name: Install dependencies
run: npm ci
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: '16'
node-version: '20'

- name: Install dependencies
run: npm ci
Expand Down
30 changes: 13 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,35 @@

Thanks for taking the time to contribute to the OpenSCD project!

The easiest way to get in touch is to join the `#open-scd` channel kindly hosted
on [the LF Energy Slack server](https://slack.lfenergy.org/). If you say "hi"
there we will be more than happy to help you find your way around this project.

## Non-Code Contributions

You don't need to be a software developer to contribute to this effort!
Apart from contributions in the form of code we are also very thankful for
You don't need to be a software developer to contribute to this effort! Apart
from contributions in the form of code we are also very thankful for
- [bug reports](
https://github.com/openscd/open-scd-core/issues?q=is%3Aopen+label%3Abug)
alerting us of errors in the `open-scd` component or its `foundation` library
https://github.com/omicronenergy/open-scd-core/issues?q=is%3Aopen) alerting
us of errors in the `open-scd` component or its `foundation` library
functions,
- [ideas for enhancements](
https://github.com/openscd/open-scd-core/discussions/categories/ideas)
to `open-scd` or its `foundation` library,
https://github.com/omicronenergy/open-scd-core/discussions/categories/ideas)
to `open-scd` or its `foundation` library,
- [contributions to discussions](
https://github.com/openscd/open-scd-core/discussions)
we're having about which direction the project should take, and
- [improvements to our wiki](https://github.com/openscd/open-scd/wiki)
https://github.com/omicronenergy/open-scd-core/discussions) we're having
about which direction the project should take, and
- [improvements to our wiki](https://github.com/omicronenergy/open-scd/wiki)
which contains knowledge about how to use both OpenSCD and SCL in general.

## Code Contributions

> The following is a set of guidelines for contributing to
> [OpenSCD Core](https://github.com/openscd/open-scd-core#readme), not a list of
> The following is a set of guidelines for contributing to [OpenSCD
> Core](https://github.com/omicronenergy/open-scd-core#readme), not a list of
> strict rules. Use your best judgment and feel free to propose changes to this
> document in a pull request.
### Code Structure

The OpenSCD Core project's [NPM package declaration file](
https://github.com/openscd/open-scd-core/blob/main/package.json)
lists two entry points that can be referred to by package users:
https://github.com/omicronenergy/open-scd-core/blob/main/package.json) lists
two entry points that can be referred to by package users:

```json
"exports": {
Expand Down
2 changes: 1 addition & 1 deletion demo/index.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<title>OpenSCD Core Demo</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto+Mono:wght@300&family=Roboto:wght@300;400;500&display=swap">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Material+Icons&display=block">
<open-scd plugins='{"menu": [{"name": "Add plugins...", "translations": {"de": "Erweitern..."}, "icon": "extension", "active": true, "src": "/demo/AddPlugins.js"}, {"name": "Open File", "translations": {"de": "Datei öffnen"}, "icon": "folder_open", "active": true, "src": "https://openscd.github.io/oscd-open/oscd-open.js"}, {"name": "Save File", "translations": {"de": "Datei öffnen"}, "icon": "save", "active": true, "src": "https://openscd.github.io/oscd-save/oscd-save.js"}]}'></open-scd>
<open-scd plugins='{"menu": [{"name": "Add plugins...", "translations": {"de": "Erweitern..."}, "icon": "extension", "active": true, "src": "/demo/AddPlugins.js"}, {"name": "Open File", "translations": {"de": "Datei öffnen"}, "icon": "folder_open", "active": true, "src": "https://openenergytools.github.io/oscd-open/oscd-open.js"}, {"name": "Save File", "translations": {"de": "Datei öffnen"}, "icon": "save", "active": true, "src": "https://openenergytools.github.io/oscd-save/oscd-save.js"}]}'></open-scd>

<script type="module">
import '../dist/open-scd.js';
Expand Down
Loading

0 comments on commit 8a4809c

Please sign in to comment.