update README and delete ci for release building
This commit is contained in:
parent
a437c068c8
commit
3310455a70
2 changed files with 9 additions and 40 deletions
32
.github/workflows/build-release.yml
vendored
32
.github/workflows/build-release.yml
vendored
|
|
@ -1,32 +0,0 @@
|
||||||
name: Pack Drupal module
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
tags:
|
|
||||||
- 'v*'
|
|
||||||
workflow_dispatch: {}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
pack:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
|
|
||||||
- name: Setup Node
|
|
||||||
uses: actions/setup-node@v6
|
|
||||||
with:
|
|
||||||
node-version: '24'
|
|
||||||
|
|
||||||
- name: Pack module zip
|
|
||||||
run: node scripts/pack-drupal-module.js
|
|
||||||
|
|
||||||
- name: Create release
|
|
||||||
uses: softprops/action-gh-release@v2
|
|
||||||
with:
|
|
||||||
tag_name: ${{ github.ref_name }}
|
|
||||||
name: Release ${{ github.ref_name }}
|
|
||||||
files: ./dfg_3dviewer-drupal.zip
|
|
||||||
17
README.md
17
README.md
|
|
@ -1,21 +1,22 @@
|
||||||
# DFG 3D Viewer — Drupal Module
|
# DFG 3D Viewer — Drupal Module
|
||||||
|
|
||||||
Drupal/WissKI integration for the [DFG 3D Viewer JavaScript library](https://github.com/your-org/js_library_dfg_3dviewer).
|
Drupal/WissKI integration for the [DFG 3D Viewer JavaScript library](https://gitlab.nasarek.dev/rnsrk/dfg_3dviewer_js_library).
|
||||||
|
|
||||||
**This repository contains PHP/YAML only** — no bundled JavaScript, no npm build step on the server.
|
**This repository contains PHP/YAML only** — no bundled JavaScript, no npm build step on the server.
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
1. **JS library** at `web/libraries/dfg-3dviewer/`:
|
1. **JS library** at `web/libraries/dfg-3dviewer/` — download from [releases](https://gitlab.nasarek.dev/rnsrk/dfg_3dviewer_js_library/-/releases), or build from `js_library_dfg_3dviewer` with `npm run build:library` / `npm run pack:library`
|
||||||
- Download `dfg-3dviewer-library.zip` from the [library releases](https://github.com/your-org/js_library_dfg_3dviewer/releases), or
|
|
||||||
- Build from the `js_library_dfg_3dviewer` repo: `npm run build:library` and copy `dist/library/*` there
|
|
||||||
|
|
||||||
2. **This module** at `web/modules/custom/dfg_3dviewer/`
|
2. **This module** at `web/modules/custom/dfg_3dviewer/` — clone this repository, or pack locally with `node scripts/pack-drupal-module.js`
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
unzip dfg-3dviewer-library.zip -d web/libraries/dfg-3dviewer
|
curl -fL "https://gitlab.nasarek.dev/rnsrk/dfg_3dviewer_js_library/-/releases/permalink/latest/downloads/dfg-3dviewer-library.zip" -o /tmp/dfg-3dviewer-library.zip
|
||||||
|
mkdir -p web/libraries/dfg-3dviewer
|
||||||
|
unzip -o /tmp/dfg-3dviewer-library.zip -d web/libraries/dfg-3dviewer
|
||||||
|
rm /tmp/dfg-3dviewer-library.zip
|
||||||
# clone or unzip this module to web/modules/custom/dfg_3dviewer
|
# clone or unzip this module to web/modules/custom/dfg_3dviewer
|
||||||
drush en dfg_3dviewer -y
|
drush en dfg_3dviewer -y
|
||||||
drush cr
|
drush cr
|
||||||
|
|
@ -40,10 +41,10 @@ Configure at `/admin/config/dfg_3dviewer`. Settings are passed to the browser as
|
||||||
- `/libraries/dfg-3dviewer/dfg_3dviewer.min.js`
|
- `/libraries/dfg-3dviewer/dfg_3dviewer.min.js`
|
||||||
- `/libraries/dfg-3dviewer/assets/css/viewer.css`
|
- `/libraries/dfg-3dviewer/assets/css/viewer.css`
|
||||||
|
|
||||||
## Release zip (maintainers)
|
## Package zip (maintainers)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
node scripts/pack-drupal-module.js
|
node scripts/pack-drupal-module.js
|
||||||
```
|
```
|
||||||
|
|
||||||
Produces `dfg_3dviewer-drupal.zip`.
|
Produces `dfg_3dviewer-drupal.zip` (gitignored).
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue