@@ -2,8 +2,8 @@ name: Release
|
|||||||
|
|
||||||
# Manual release: from the GitHub "Actions" tab pick "Release", click
|
# Manual release: from the GitHub "Actions" tab pick "Release", click
|
||||||
# "Run workflow", enter the version tag, and it builds the Windows installer
|
# "Run workflow", enter the version tag, and it builds the Windows installer
|
||||||
# .exe and the Linux tarball + .deb, then publishes a GitHub Release with all
|
# .exe, then publishes a GitHub Release with that artifact attached and
|
||||||
# artifacts attached and auto-generated notes.
|
# auto-generated notes.
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
@@ -68,41 +68,9 @@ jobs:
|
|||||||
path: releases/*.exe
|
path: releases/*.exe
|
||||||
if-no-files-found: error
|
if-no-files-found: error
|
||||||
|
|
||||||
build-linux:
|
|
||||||
name: Build Linux tarball + .deb
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: 20
|
|
||||||
cache: npm
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
|
|
||||||
- name: Set version from input
|
|
||||||
shell: bash
|
|
||||||
env:
|
|
||||||
VERSION: ${{ inputs.version }}
|
|
||||||
run: npm version "${VERSION#v}" --no-git-tag-version --allow-same-version
|
|
||||||
|
|
||||||
- name: Package Linux artifacts (tarball + .deb)
|
|
||||||
shell: bash
|
|
||||||
env:
|
|
||||||
STEPFORGE_PACKAGE_DIR: ${{ github.workspace }}/build/artifacts
|
|
||||||
run: bash scripts/package-linux.sh
|
|
||||||
|
|
||||||
- uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: linux-artifacts
|
|
||||||
path: build/artifacts/*
|
|
||||||
if-no-files-found: error
|
|
||||||
|
|
||||||
release:
|
release:
|
||||||
name: Publish GitHub Release
|
name: Publish GitHub Release
|
||||||
needs: [build-windows, build-linux]
|
needs: [build-windows]
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
@@ -127,7 +95,6 @@ jobs:
|
|||||||
fi
|
fi
|
||||||
gh release create "$TAG" \
|
gh release create "$TAG" \
|
||||||
dist/windows-installer/*.exe \
|
dist/windows-installer/*.exe \
|
||||||
dist/linux-artifacts/* \
|
|
||||||
--title "StepForge $TAG" \
|
--title "StepForge $TAG" \
|
||||||
--target "${{ github.sha }}" \
|
--target "${{ github.sha }}" \
|
||||||
--generate-notes \
|
--generate-notes \
|
||||||
|
|||||||
@@ -1,9 +1,11 @@
|
|||||||
# StepForge
|
# StepForge
|
||||||
|
|
||||||
StepForge is a **fully offline**, open-source desktop app for Windows and
|
StepForge is a **fully offline**, open-source desktop app for Windows, with
|
||||||
Linux that captures step-by-step workflows as screenshots, lets you annotate
|
Linux (WIP) builds. It captures step-by-step workflows as screenshots, lets
|
||||||
and describe each step in a focused three-pane editor, and exports the result
|
you annotate and describe each step in a focused three-pane editor, and
|
||||||
to Markdown, DOCX, PPTX, PDF, HTML (WIP), GIF (WIP), confluence (WIP), Wiki.js (WIP), and image bundles (WIP). The current reconmendations for exporting is Markdown and PDF.
|
exports the result to Markdown, DOCX, PPTX, PDF, HTML (WIP), GIF (WIP),
|
||||||
|
confluence (WIP), Wiki.js (WIP), and image bundles (WIP). The current
|
||||||
|
reconmendations for exporting is Markdown and PDF.
|
||||||
|
|
||||||
It is an independent offline desktop guide-capture tool inspired by publicly
|
It is an independent offline desktop guide-capture tool inspired by publicly
|
||||||
documented workflow patterns of commercial documentation tools like Folge. It contains no
|
documented workflow patterns of commercial documentation tools like Folge. It contains no
|
||||||
@@ -60,7 +62,7 @@ using only Node built-ins.
|
|||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
For a windows installation, see [docs/windows_installation](docs/windows_installation.md) or for a developer/more in depth walkthrough, see [docs/GETTING_STARTED.md](docs/GETTING_STARTED.md).
|
For a Windows installation, see [docs/windows_installation](docs/windows_installation.md) or for a developer/more in depth walkthrough, see [docs/GETTING_STARTED.md](docs/GETTING_STARTED.md).
|
||||||
|
|
||||||
Requirements: Node.js 20+ and npm (Electron is the only dependency).
|
Requirements: Node.js 20+ and npm (Electron is the only dependency).
|
||||||
|
|
||||||
@@ -70,7 +72,8 @@ npm start # launch StepForge
|
|||||||
```
|
```
|
||||||
|
|
||||||
First run creates the local data directory (`~/.local/share/stepforge` on
|
First run creates the local data directory (`~/.local/share/stepforge` on
|
||||||
Linux, `%APPDATA%/stepforge` on Windows; override with `STEPFORGE_DATA_DIR`).
|
Linux (WIP), `%APPDATA%/stepforge` on Windows; override with
|
||||||
|
`STEPFORGE_DATA_DIR`).
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
@@ -92,7 +95,7 @@ documents, and validating the bytes of the output, not string matching.
|
|||||||
bash scripts/bootstrap-offline.sh # verify toolchain availability
|
bash scripts/bootstrap-offline.sh # verify toolchain availability
|
||||||
bash scripts/verify.sh # full test suite + smoke checks
|
bash scripts/verify.sh # full test suite + smoke checks
|
||||||
bash scripts/build-release.sh # assemble runnable app directory
|
bash scripts/build-release.sh # assemble runnable app directory
|
||||||
bash scripts/package-linux.sh # portable tar.gz + .deb (+ AppDir spec)
|
bash scripts/package-linux.sh # local Linux packaging (WIP; not part of release)
|
||||||
npm run package:windows # Windows installer .exe in releases/
|
npm run package:windows # Windows installer .exe in releases/
|
||||||
pwsh scripts/package-windows.ps1 # same Windows installer build via PowerShell
|
pwsh scripts/package-windows.ps1 # same Windows installer build via PowerShell
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -111,7 +111,7 @@ click position. Three pieces make that hold:
|
|||||||
|
|
||||||
1. **OS click events** (`app/capture.js`): a low-level mouse hook on Windows
|
1. **OS click events** (`app/capture.js`): a low-level mouse hook on Windows
|
||||||
(`CLICK x y button unixMs` lines), an `xinput test-xi2 --root` watcher on
|
(`CLICK x y button unixMs` lines), an `xinput test-xi2 --root` watcher on
|
||||||
X11. The Linux parser carries event-time `root:` coordinates and merges
|
X11. The Linux (WIP) parser carries event-time `root:` coordinates and merges
|
||||||
raw/regular twin blocks structurally — there is no time-based debounce
|
raw/regular twin blocks structurally — there is no time-based debounce
|
||||||
that could drop fast clicks, only suppression of identical duplicate
|
that could drop fast clicks, only suppression of identical duplicate
|
||||||
deliveries. Physical coordinates convert to DIP via
|
deliveries. Physical coordinates convert to DIP via
|
||||||
|
|||||||
@@ -25,9 +25,9 @@ That installs Electron and the local packaging tools used by the scripts.
|
|||||||
npm start
|
npm start
|
||||||
```
|
```
|
||||||
|
|
||||||
The first launch creates the local StepForge data directory. On Linux it is
|
The first launch creates the local StepForge data directory. On Linux (WIP)
|
||||||
usually under `~/.local/share/stepforge`. On Windows it is usually under
|
it is usually under `~/.local/share/stepforge`. On Windows it is usually
|
||||||
`%APPDATA%/stepforge`.
|
under `%APPDATA%/stepforge`.
|
||||||
|
|
||||||
## 3. Create your first guide
|
## 3. Create your first guide
|
||||||
|
|
||||||
@@ -95,4 +95,5 @@ If you want to find commands quickly, press `Ctrl+/` for Quick Actions.
|
|||||||
1. `bash scripts/build-release.sh` assembles the offline release layout.
|
1. `bash scripts/build-release.sh` assembles the offline release layout.
|
||||||
2. `npm run package:windows` creates the Windows installer `.exe` in
|
2. `npm run package:windows` creates the Windows installer `.exe` in
|
||||||
`releases/`.
|
`releases/`.
|
||||||
3. `bash scripts/package-linux.sh` creates Linux release artifacts.
|
3. `bash scripts/package-linux.sh` creates Linux release artifacts (WIP;
|
||||||
|
local only).
|
||||||
|
|||||||
Reference in New Issue
Block a user