4 Commits
Author SHA1 Message Date
Tyler c2247a57c7 Bulk documentation edits
Template tests / tests (push) Successful in 1m44s
2026-06-22 09:50:29 -05:00
Tyler d89abf5b78 Arm capture when creating a guide from the library
createGuide() opened the new guide with plain openGuide(), so no capture
session was armed — the "Start recording" bar never bound to the new guide,
and clicking it did nothing (or resumed a stale prior session). Every other
open path (guide cards, search results, New Capture) arms a paused session;
this aligns createGuide() with them via openGuideAndArmCapture().
2026-06-16 13:13:32 -05:00
Tyler 845b3ed205 Add GitHub Actions: CI and a manual release workflow
- ci.yml: runs the unit test suite (npm test → node --test tests/unit) on
  push and PR to main, across ubuntu/windows/macos with Node 20. Electron is
  installed normally because the capture unit tests require app/capture.js,
  which require()s the electron module at load.

- release.yml: manual workflow_dispatch. Enter a version tag (e.g. v0.1.1);
  it builds the Windows portable .exe (npm run package:windows) and the Linux
  tarball + .deb (scripts/package-linux.sh), stamps the requested version onto
  each artifact, then publishes a GitHub Release at the current commit with
  the artifacts attached and auto-generated notes. Supports a prerelease flag.
2026-06-16 12:39:19 -05:00
Tyler 3def598528 Tighten battery capture: cover lazily-spawned capture processes, widen warmup
Follow-up polish after the EcoQoS fix landed and recordings improved:

- Re-apply the EcoQoS opt-out when the stream backend reports it is active.
  Chromium spawns/upgrades its GPU and screen-capture utility processes only
  once the desktop stream actually starts — after the session-start sweep —
  so they could still be born throttled. Hooking the capture:state transition
  to 'stream' catches them the moment they appear.

- Raise the warmup cap from 1500ms to 3000ms. The recorder window stays
  visible during warmup (the user hasn't started their workflow yet) and the
  common path still proceeds the instant the stream is ready, so the extra
  headroom only matters when stream startup is slow on battery — where it
  buys a real pre-click frame for the very first click instead of a
  post-click fresh shot.
2026-06-16 08:15:46 -05:00
13 changed files with 216 additions and 418 deletions
-6
View File
@@ -7,12 +7,6 @@
- [ ] Git / workflow - [ ] Git / workflow
- [ ] Other - [ ] Other
## Issue Type
- [ ] Bug
- [ ] Improvement
- [ ] Task
- [ ] Documentation
## Summary ## Summary
+7 -1
View File
@@ -1,15 +1,21 @@
<!-- please delete the unused check box's on the creation of your pr -->
## Improvement Area ## Improvement Area
- [ ] Guide Editor
- [ ] Library
- [ ] Settings
- [ ] Exports
- [ ] Documentation - [ ] Documentation
- [ ] Tests - [ ] Tests
- [ ] Git / workflow - [ ] Git / workflow
- [ ] Other - [ ] Other
## Issue ## Issue
<!-- Replace the example with the issue number this PR resolves. -->
- Closes # - Closes #
<!-- Replace the example with the issue number this PR resolves. -->
## Summary ## Summary
+37
View File
@@ -0,0 +1,37 @@
name: CI
on:
push:
branches: [main]
pull_request:
branches: [main]
# Cancel an in-progress run when newer commits are pushed to the same ref.
concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true
jobs:
test:
name: Unit tests (${{ matrix.os }})
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
# The capture unit tests require app/capture.js, which require()s the
# electron module at load — so the Electron binary must actually be
# installed (don't set ELECTRON_SKIP_BINARY_DOWNLOAD here).
- name: Install dependencies
run: npm ci
- name: Run unit tests
run: npm test
+119
View File
@@ -0,0 +1,119 @@
name: Release
# Manual release: from the GitHub "Actions" tab pick "Release", click
# "Run workflow", enter the version tag, and it builds the Windows portable
# .exe and the Linux tarball + .deb, then publishes a GitHub Release with all
# artifacts attached and auto-generated notes.
on:
workflow_dispatch:
inputs:
version:
description: 'Release tag, e.g. v0.1.1 (the tag is created at the current commit on this branch)'
required: true
type: string
prerelease:
description: 'Mark this release as a pre-release'
required: false
default: false
type: boolean
# Needed for the release job to create the tag and the GitHub Release.
permissions:
contents: write
jobs:
build-windows:
name: Build Windows portable
runs-on: windows-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
- name: Install dependencies
run: npm ci
# Stamp the requested version onto package.json so the produced artifact
# carries it. Not committed back — it only affects this build.
- 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 Windows portable .exe
run: npm run package:windows
- uses: actions/upload-artifact@v4
with:
name: windows-portable
path: releases/*.exe
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:
name: Publish GitHub Release
needs: [build-windows, build-linux]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Download build artifacts
uses: actions/download-artifact@v4
with:
path: dist
- name: List downloaded artifacts
run: find dist -type f -printf '%s\t%p\n'
- name: Create GitHub Release
env:
GH_TOKEN: ${{ github.token }}
TAG: ${{ inputs.version }}
PRERELEASE: ${{ inputs.prerelease }}
run: |
flags=()
if [ "$PRERELEASE" = "true" ]; then
flags+=(--prerelease)
fi
gh release create "$TAG" \
dist/windows-portable/* \
dist/linux-artifacts/* \
--title "StepForge $TAG" \
--target "${{ github.sha }}" \
--generate-notes \
"${flags[@]}"
+3 -19
View File
@@ -3,8 +3,7 @@
StepForge is a **fully offline**, open-source desktop app for Windows and StepForge is a **fully offline**, open-source desktop app for Windows and
Linux that captures step-by-step workflows as screenshots, lets you annotate Linux that captures step-by-step workflows as screenshots, lets you annotate
and describe each step in a focused three-pane editor, and exports the result and describe each step in a focused three-pane editor, and exports the result
to JSON, Markdown, HTML (simple and rich), PDF, animated GIF, image bundles, 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.
DOCX, and PPTX.
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. It contains no documented workflow patterns of commercial documentation tools. It contains no
@@ -27,21 +26,6 @@ The core workflow:
4. **Export** — every exporter renders from the same normalized Render AST, 4. **Export** — every exporter renders from the same normalized Render AST,
so output is deterministic across formats. so output is deterministic across formats.
```text
┌────────────────────────────────────────────────────────────────────────────┐
│ StepForge > Reset Password SOP [Capture] [Export] [Save] │
├──────────────────┬──────────────────────────────────┬──────────────────────┤
│ Steps │ Canvas │ Properties │
│ 1 Open Users │ ┌────────────────────────────┐ │ Title │
│ 2 Search account │ │ [tooltip] │ │ [Reset password] │
│ 3 Click Reset │ │ ↘ ┌────────────┐ │ │ Description │
│ 3.1 Warning │ │ │ Reset btn │ │ │ [rich text editor] │
│ 4 Done │ │ └────────────┘ │ │ Text blocks │
│ [Add Step] │ └────────────────────────────┘ │ Step settings │
├──────────────────┴──────────────────────────────────┴──────────────────────┤
│ Tools: [Select][Rect][Oval][Line][Arrow][Text][Tooltip][#][Blur][Hi][Crop] │
└────────────────────────────────────────────────────────────────────────────┘
```
## What's Included ## What's Included
@@ -99,8 +83,8 @@ bash tests/run_test.sh
The runner executes every `tests/checks/test_*.sh` script; those scripts run The runner executes every `tests/checks/test_*.sh` script; those scripts run
the workflow test suites under `tests/unit/` with `node --test`. The tests the workflow test suites under `tests/unit/` with `node --test`. The tests
exercise real workflows creating guides, round-tripping archives, exporting exercise real workflows like creating guides, round-tripping archives, exporting
documents, and validating the bytes of the output not string matching. documents, and validating the bytes of the output, not string matching.
## Building & Packaging ## Building & Packaging
+8 -3
View File
@@ -56,9 +56,14 @@ const DEFAULT_CLICK_DEBOUNCE_MS = 200;
// representation that carries root coordinates) before firing without them. // representation that carries root coordinates) before firing without them.
const LINUX_CLICK_TWIN_MS = 25; const LINUX_CLICK_TWIN_MS = 25;
// Longest the window stays visible warming up the recorder at recording // Longest the window stays visible warming up the recorder at recording
// start. A slow capture-stream start (Windows can take several seconds) must // start. A slow capture-stream start (Windows can take several seconds,
// not keep the window up and recording un-armed indefinitely. // especially on battery) must not keep the window up and recording un-armed
const WARMUP_MAX_MS = 1500; // indefinitely — but the window is still visible during warmup, so the user
// hasn't begun their workflow yet, and the common case still proceeds the
// instant the stream is ready. The cap only bites when startup is slow, where
// a little more headroom buys a pre-click frame for the very first click
// instead of a post-click fresh shot.
const WARMUP_MAX_MS = 3000;
// Idle gap between legacy frame-loop grabs. Must stay well above zero: // Idle gap between legacy frame-loop grabs. Must stay well above zero:
// grabbing back-to-back starves the main-process event loop, which delays // grabbing back-to-back starves the main-process event loop, which delays
// delivery of click events from the OS watcher by whole seconds. (The // delivery of click events from the OS watcher by whole seconds. (The
+16 -1
View File
@@ -733,11 +733,26 @@ if (!gotLock) {
settings = new Settings(store.settingsDir); settings = new Settings(store.settingsDir);
searchIndex = new SearchIndex(store.indexDir); searchIndex = new SearchIndex(store.indexDir);
templates = new TemplateManager(store.templatesDir); templates = new TemplateManager(store.templatesDir);
// Bringing up the desktop-capture stream spawns/upgrades Chromium's GPU
// and screen-capture utility processes — which can be born after a session
// already started, so the start-time EcoQoS opt-out misses them. Re-apply
// it the moment the backend reports it is streaming.
let lastClickFrameSource = null;
const captureNotify = (channel, payload) => {
sendToRenderer(channel, payload);
if (channel === 'capture:state' && payload && payload.clickFrameSource !== lastClickFrameSource) {
lastClickFrameSource = payload.clickFrameSource;
if (payload.clickFrameSource === 'stream') {
try { keepProcessesResponsive(app.getAppMetrics().map((m) => m.pid)); } catch { /* best effort */ }
}
}
};
capture = new CaptureService({ capture = new CaptureService({
store, store,
settings, settings,
getWindow: () => mainWindow, getWindow: () => mainWindow,
notify: sendToRenderer, notify: captureNotify,
}); });
applyTheme(); applyTheme();
+5 -1
View File
@@ -757,7 +757,11 @@ class StepForgeApp {
if (title == null) return; if (title == null) return;
const guide = await api.library.create({ title: title.trim() || 'Untitled guide' }); const guide = await api.library.create({ title: title.trim() || 'Untitled guide' });
await this.refreshLibrary(); await this.refreshLibrary();
await this.openGuide(guide.guideId); // Arm a (paused) capture session like every other open path, so the
// "Start recording" bar appears and actually controls this new guide.
// Without this, a guide created from the library opened with no session,
// so Start recording had nothing to resume (or resumed a stale one).
await this.openGuideAndArmCapture(guide.guideId);
} }
async createFolder() { async createFolder() {
+2 -3
View File
@@ -16,9 +16,8 @@ filing issues — is expected to:
Maintainers may edit, hide, or remove comments, commits, issues, and PRs that Maintainers may edit, hide, or remove comments, commits, issues, and PRs that
violate this standard, and may temporarily or permanently ban contributors violate this standard, and may temporarily or permanently ban contributors
for repeated or egregious behavior. for egregious behavior. We may do this at any time without warning and without chance for appeal.
## Reporting ## Reporting
Report unacceptable behavior privately to the maintainers via the contact Report unacceptable behavior privately to the maintainers via `[email protected]`. Reports are handled confidentially.
listed on the project page. Reports are handled confidentially.
+6 -7
View File
@@ -29,9 +29,10 @@ Origin sign-off (`git commit -s`).
## Offline Rules ## Offline Rules
- No network code paths in the application. No telemetry, update checks, - No network code paths in the application. No telemetry, update checks,
license checks, remote fonts, or remote APIs — ever. license checks, remote fonts, or remote APIs — **ever**.
- No new runtime dependencies without prior maintainer agreement; prefer - No new runtime dependencies without prior maintainer agreement; prefer
internal implementations using Node built-ins. internal implementations using Node built-ins. This is due to all the
security issues that have arrose lately with NPM dependencies.
## Branching ## Branching
@@ -46,8 +47,7 @@ Origin sign-off (`git commit -s`).
`Closes #123`, `Fixes #123`, or `Relates to #123`. `Closes #123`, `Fixes #123`, or `Relates to #123`.
- Summarize the change clearly and call out anything a reviewer should - Summarize the change clearly and call out anything a reviewer should
verify manually. verify manually.
- Update docs when behavior changes, and add a CHANGELOG entry for every - Update docs when behavior changes.
user-visible change.
- Every exporter or storage change **requires tests**; output changes - Every exporter or storage change **requires tests**; output changes
require updated snapshot fixtures under `tests/fixtures/`. require updated snapshot fixtures under `tests/fixtures/`.
@@ -64,10 +64,9 @@ automatically. The shell checks invoke the `node --test` workflow suites in
`tests/unit/`. `tests/unit/`.
Write tests that exercise **real workflows and verify actual output** Write tests that exercise **real workflows and verify actual output**
create a guide, export it, parse the bytes that came out — rather than create a guide, export it, parse the bytes that came out. DO NOT WRITE A TEST THAT GREPS FOR CODE.
grepping for magic strings.
The Gitea workflow in `.gitea/workflows/tests.yaml` runs the same command The Gitea workflow in `.gitea/workflows/tests.yaml` and `.github/workflows/ci.yaml` runs the same command
automatically on pushes and pull requests. automatically on pushes and pull requests.
Please add lots of tests to each of your PR's and be descriptive with the Please add lots of tests to each of your PR's and be descriptive with the
+6 -5
View File
@@ -28,7 +28,7 @@ usually under `~/.local/share/stepforge`. On Windows it is usually under
In the library view: In the library view:
1. Click `New guide`. 1. Click `New guide`.
2. Give the guide a clear title. 2. Give the guide a clear title (more -> rename guide).
3. Open the guide to enter the editor. 3. Open the guide to enter the editor.
You can also import a guide archive with `Import archive` if you already have You can also import a guide archive with `Import archive` if you already have
@@ -36,10 +36,11 @@ one.
## 4. Add content ## 4. Add content
There are two simple ways to start: There are three simple ways to start:
1. Import screenshots with the `Import` button in the editor. 1. Record your workflow by clicking on the record button (reconmmended).
2. Paste an image from the clipboard if you already copied one. 2. Import screenshots with the `Import` button in the editor.
3. Paste an image from the clipboard if you already copied one.
If you want to capture new screenshots, open `Quick` actions and start a If you want to capture new screenshots, open `Quick` actions and start a
capture session. Use `Settings` to set the capture hotkey and other capture capture session. Use `Settings` to set the capture hotkey and other capture
@@ -50,7 +51,7 @@ options.
The editor is split into three panes: The editor is split into three panes:
1. Steps on the left 1. Steps on the left
2. Canvas in the center 2. Editing canvas in the center
3. Properties on the right 3. Properties on the right
Use the canvas tools to add shapes, arrows, text, blur, highlight, numbers, Use the canvas tools to add shapes, arrows, text, blur, highlight, numbers,
+5 -369
View File
@@ -1,373 +1,9 @@
Mozilla Public License Version 2.0 Creative Commons Attribution-NonCommercial
==================================
1. Definitions Copyright (c) 2026 Tyler Westbrook
--------------
1.1. "Contributor" Permission is granted to use, copy, modify, and distribute this software for non-commercial purposes only.
means each individual or legal entity that creates, contributes to
the creation of, or owns Covered Software.
1.2. "Contributor Version" You may not sell this software, sell modified versions of it, or use it as part of a commercial product or service without written permission from the copyright holder.
means the combination of the Contributions of others (if any) used
by a Contributor and that particular Contributor's Contribution.
1.3. "Contribution" This software is provided "as is", without warranty of any kind.
means Covered Software of a particular Contributor.
1.4. "Covered Software"
means Source Code Form to which the initial Contributor has attached
the notice in Exhibit A, the Executable Form of such Source Code
Form, and Modifications of such Source Code Form, in each case
including portions thereof.
1.5. "Incompatible With Secondary Licenses"
means
(a) that the initial Contributor has attached the notice described
in Exhibit B to the Covered Software; or
(b) that the Covered Software was made available under the terms of
version 1.1 or earlier of the License, but not also under the
terms of a Secondary License.
1.6. "Executable Form"
means any form of the work other than Source Code Form.
1.7. "Larger Work"
means a work that combines Covered Software with other material, in
a separate file or files, that is not Covered Software.
1.8. "License"
means this document.
1.9. "Licensable"
means having the right to grant, to the maximum extent possible,
whether at the time of the initial grant or subsequently, any and
all of the rights conveyed by this License.
1.10. "Modifications"
means any of the following:
(a) any file in Source Code Form that results from an addition to,
deletion from, or modification of the contents of Covered
Software; or
(b) any new file in Source Code Form that contains any Covered
Software.
1.11. "Patent Claims" of a Contributor
means any patent claim(s), including without limitation, method,
process, and apparatus claims, in any patent Licensable by such
Contributor that would be infringed, but for the grant of the
License, by the making, using, selling, offering for sale, having
made, import, or transfer of either its Contributions or its
Contributor Version.
1.12. "Secondary License"
means either the GNU General Public License, Version 2.0, the GNU
Lesser General Public License, Version 2.1, the GNU Affero General
Public License, Version 3.0, or any later versions of those
licenses.
1.13. "Source Code Form"
means the form of the work preferred for making modifications.
1.14. "You" (or "Your")
means an individual or a legal entity exercising rights under this
License. For legal entities, "You" includes any entity that
controls, is controlled by, or is under common control with You. For
purposes of this definition, "control" means (a) the power, direct
or indirect, to cause the direction or management of such entity,
whether by contract or otherwise, or (b) ownership of more than
fifty percent (50%) of the outstanding shares or beneficial
ownership of such entity.
2. License Grants and Conditions
--------------------------------
2.1. Grants
Each Contributor hereby grants You a world-wide, royalty-free,
non-exclusive license:
(a) under intellectual property rights (other than patent or trademark)
Licensable by such Contributor to use, reproduce, make available,
modify, display, perform, distribute, and otherwise exploit its
Contributions, either on an unmodified basis, with Modifications, or
as part of a Larger Work; and
(b) under Patent Claims of such Contributor to make, use, sell, offer
for sale, have made, import, and otherwise transfer either its
Contributions or its Contributor Version.
2.2. Effective Date
The licenses granted in Section 2.1 with respect to any Contribution
become effective for each Contribution on the date the Contributor first
distributes such Contribution.
2.3. Limitations on Grant Scope
The licenses granted in this Section 2 are the only rights granted under
this License. No additional rights or licenses will be implied from the
distribution or licensing of Covered Software under this License.
Notwithstanding Section 2.1(b) above, no patent license is granted by a
Contributor:
(a) for any code that a Contributor has removed from Covered Software;
or
(b) for infringements caused by: (i) Your and any other third party's
modifications of Covered Software, or (ii) the combination of its
Contributions with other software (except as part of its Contributor
Version); or
(c) under Patent Claims infringed by Covered Software in the absence of
its Contributions.
This License does not grant any rights in the trademarks, service marks,
or logos of any Contributor (except as may be necessary to comply with
the notice requirements in Section 3.4).
2.4. Subsequent Licenses
No Contributor makes additional grants as a result of Your choice to
distribute the Covered Software under a subsequent version of this
License (see Section 10.2) or under the terms of a Secondary License (if
permitted under the terms of Section 3.3).
2.5. Representation
Each Contributor represents that the Contributor believes its
Contributions are its original creation(s) or it has sufficient rights
to grant the rights to its Contributions conveyed by this License.
2.6. Fair Use
This License is not intended to limit any rights You have under
applicable copyright doctrines of fair use, fair dealing, or other
equivalents.
2.7. Conditions
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
in Section 2.1.
3. Responsibilities
-------------------
3.1. Distribution of Source Form
All distribution of Covered Software in Source Code Form, including any
Modifications that You create or to which You contribute, must be under
the terms of this License. You must inform recipients that the Source
Code Form of the Covered Software is governed by the terms of this
License, and how they can obtain a copy of this License. You may not
attempt to alter or restrict the recipients' rights in the Source Code
Form.
3.2. Distribution of Executable Form
If You distribute Covered Software in Executable Form then:
(a) such Covered Software must also be made available in Source Code
Form, as described in Section 3.1, and You must inform recipients of
the Executable Form how they can obtain a copy of such Source Code
Form by reasonable means in a timely manner, at a charge no more
than the cost of distribution to the recipient; and
(b) You may distribute such Executable Form under the terms of this
License, or sublicense it under different terms, provided that the
license for the Executable Form does not attempt to limit or alter
the recipients' rights in the Source Code Form under this License.
3.3. Distribution of a Larger Work
You may create and distribute a Larger Work under terms of Your choice,
provided that You also comply with the requirements of this License for
the Covered Software. If the Larger Work is a combination of Covered
Software with a work governed by one or more Secondary Licenses, and the
Covered Software is not Incompatible With Secondary Licenses, this
License permits You to additionally distribute such Covered Software
under the terms of such Secondary License(s), so that the recipient of
the Larger Work may, at their option, further distribute the Covered
Software under the terms of either this License or such Secondary
License(s).
3.4. Notices
You may not remove or alter the substance of any license notices
(including copyright notices, patent notices, disclaimers of warranty,
or limitations of liability) contained within the Source Code Form of
the Covered Software, except that You may alter any license notices to
the extent required to remedy known factual inaccuracies.
3.5. Application of Additional Terms
You may choose to offer, and to charge a fee for, warranty, support,
indemnity or liability obligations to one or more recipients of Covered
Software. However, You may do so only on Your own behalf, and not on
behalf of any Contributor. You must make it absolutely clear that any
such warranty, support, indemnity, or liability obligation is offered by
You alone, and You hereby agree to indemnify every Contributor for any
liability incurred by such Contributor as a result of warranty, support,
indemnity or liability terms You offer. You may include additional
disclaimers of warranty and limitations of liability specific to any
jurisdiction.
4. Inability to Comply Due to Statute or Regulation
---------------------------------------------------
If it is impossible for You to comply with any of the terms of this
License with respect to some or all of the Covered Software due to
statute, judicial order, or regulation then You must: (a) comply with
the terms of this License to the maximum extent possible; and (b)
describe the limitations and the code they affect. Such description must
be placed in a text file included with all distributions of the Covered
Software under this License. Except to the extent prohibited by statute
or regulation, such description must be sufficiently detailed for a
recipient of ordinary skill to be able to understand it.
5. Termination
--------------
5.1. The rights granted under this License will terminate automatically
if You fail to comply with any of its terms. However, if You become
compliant, then the rights granted under this License from a particular
Contributor are reinstated (a) provisionally, unless and until such
Contributor explicitly and finally terminates Your grants, and (b) on an
ongoing basis, if such Contributor fails to notify You of the
non-compliance by some reasonable means prior to 60 days after You have
come back into compliance. Moreover, Your grants from a particular
Contributor are reinstated on an ongoing basis if such Contributor
notifies You of the non-compliance by some reasonable means, this is the
first time You have received notice of non-compliance with this License
from such Contributor, and You become compliant prior to 30 days after
Your receipt of the notice.
5.2. If You initiate litigation against any entity by asserting a patent
infringement claim (excluding declaratory judgment actions,
counter-claims, and cross-claims) alleging that a Contributor Version
directly or indirectly infringes any patent, then the rights granted to
You by any and all Contributors for the Covered Software under Section
2.1 of this License shall terminate.
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
end user license agreements (excluding distributors and resellers) which
have been validly granted by You or Your distributors under this License
prior to termination shall survive termination.
************************************************************************
* *
* 6. Disclaimer of Warranty *
* ------------------------- *
* *
* Covered Software is provided under this License on an "as is" *
* basis, without warranty of any kind, either expressed, implied, or *
* statutory, including, without limitation, warranties that the *
* Covered Software is free of defects, merchantable, fit for a *
* particular purpose or non-infringing. The entire risk as to the *
* quality and performance of the Covered Software is with You. *
* Should any Covered Software prove defective in any respect, You *
* (not any Contributor) assume the cost of any necessary servicing, *
* repair, or correction. This disclaimer of warranty constitutes an *
* essential part of this License. No use of any Covered Software is *
* authorized under this License except under this disclaimer. *
* *
************************************************************************
************************************************************************
* *
* 7. Limitation of Liability *
* -------------------------- *
* *
* Under no circumstances and under no legal theory, whether tort *
* (including negligence), contract, or otherwise, shall any *
* Contributor, or anyone who distributes Covered Software as *
* permitted above, be liable to You for any direct, indirect, *
* special, incidental, or consequential damages of any character *
* including, without limitation, damages for lost profits, loss of *
* goodwill, work stoppage, computer failure or malfunction, or any *
* and all other commercial damages or losses, even if such party *
* shall have been informed of the possibility of such damages. This *
* limitation of liability shall not apply to liability for death or *
* personal injury resulting from such party's negligence to the *
* extent applicable law prohibits such limitation. Some *
* jurisdictions do not allow the exclusion or limitation of *
* incidental or consequential damages, so this exclusion and *
* limitation may not apply to You. *
* *
************************************************************************
8. Litigation
-------------
Any litigation relating to this License may be brought only in the
courts of a jurisdiction where the defendant maintains its principal
place of business and such litigation shall be governed by laws of that
jurisdiction, without reference to its conflict-of-law provisions.
Nothing in this Section shall prevent a party's ability to bring
cross-claims or counter-claims.
9. Miscellaneous
----------------
This License represents the complete agreement concerning the subject
matter hereof. If any provision of this License is held to be
unenforceable, such provision shall be reformed only to the extent
necessary to make it enforceable. Any law or regulation which provides
that the language of a contract shall be construed against the drafter
shall not be used to construe this License against a Contributor.
10. Versions of the License
---------------------------
10.1. New Versions
Mozilla Foundation is the license steward. Except as provided in Section
10.3, no one other than the license steward has the right to modify or
publish new versions of this License. Each version will be given a
distinguishing version number.
10.2. Effect of New Versions
You may distribute the Covered Software under the terms of the version
of the License under which You originally received the Covered Software,
or under the terms of any subsequent version published by the license
steward.
10.3. Modified Versions
If you create software not governed by this License, and you want to
create a new license for such software, you may create and use a
modified version of this License if you rename the license and remove
any references to the name of the license steward (except to note that
such modified license differs from this License).
10.4. Distributing Source Code Form that is Incompatible With Secondary
Licenses
If You choose to distribute Source Code Form that is Incompatible With
Secondary Licenses under the terms of this version of the License, the
notice described in Exhibit B of this License must be attached.
Exhibit A - Source Code Form License Notice
-------------------------------------------
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
If it is not possible or desirable to put the notice in a particular
file, then You may include the notice in a location (such as a LICENSE
file in a relevant directory) where a recipient would be likely to look
for such a notice.
You may add additional accurate notices of copyright ownership.
Exhibit B - "Incompatible With Secondary Licenses" Notice
---------------------------------------------------------
This Source Code Form is "Incompatible With Secondary Licenses", as
defined by the Mozilla Public License, v. 2.0.
+2 -3
View File
@@ -64,6 +64,5 @@ URLs) before storage and again before rendering or export.
## Reporting ## Reporting
Report vulnerabilities by opening an issue marked `security` (this is a Report vulnerabilities by sending an email to `[email protected]`
local-only tool, so coordinated disclosure pressure is low; do not include
exploit archives directly — describe the structure instead).