Skip to content
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
34 changes: 34 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
version: 2
updates:
# The documentation site (docs-site/): @avunu/docusystem and the packages it brings. A person reviews
# these pull requests: a merge to the default branch publishes the site (see the auto-merge workflow, if any).
- package-ecosystem: npm
directory: /docs-site
schedule:
interval: weekly
cooldown:
default-days: 7
exclude:
- "@avunu/docusystem"
groups:
docs-site-packages:
patterns: ["*"]
commit-message:
prefix: chore

# The pinned commit of the shared documentation workflows in .github/workflows/docs*.yml. A person
# reviews these pull requests too: a merge to the default branch publishes the site with the new
# workflow code (see the auto-merge workflow, if any).
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
cooldown:
default-days: 7
exclude:
- Avunu/docusystem
groups:
docs-actions:
patterns: ["*"]
commit-message:
prefix: ci
32 changes: 32 additions & 0 deletions .github/workflows/docs-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Docs publish

# Builds the documentation on the default branch and publishes it to GitHub Pages once a maintainer
# has set the repository variable DOCS_SITE_ENABLED to true (until then it only builds and checks).
# Runs on push and by hand, never on a pull request, so it never sees a pull request's token.
on:
push:
paths:
- docs/**
- docs-site/**
- .github/workflows/docs.yml
- .github/workflows/docs-publish.yml
workflow_dispatch:

permissions: {}

jobs:
build:
permissions:
contents: read # checkout
uses: Avunu/docusystem/.github/workflows/docs-build.yml@5f97ba8d997b882044ad6d6e7c66dca9194a8422 # v0.1.0
with:
site-directory: docs-site
pages-artifact: ${{ vars.DOCS_SITE_ENABLED == 'true' }}

deploy:
needs: build
if: ${{ vars.DOCS_SITE_ENABLED == 'true' }}
permissions:
pages: write # publish the artifact
id-token: write # prove to Pages that this run made it
uses: Avunu/docusystem/.github/workflows/docs-deploy.yml@5f97ba8d997b882044ad6d6e7c66dca9194a8422 # v0.1.0
26 changes: 26 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Docs

# Checks the documentation on every pull request that touches it. The work is done by the shared
# workflow of Avunu/docusystem, pinned to a commit (Dependabot's github-actions entry moves the pin).
# Nothing here can publish: the token is read-only. Publishing is docs-publish.yml.
on:
pull_request:
paths:
- docs/**
- docs-site/**
- .github/workflows/docs.yml
- .github/workflows/docs-publish.yml

permissions: {}

concurrency:
group: docs-${{ github.event.pull_request.number }}
cancel-in-progress: true

jobs:
build:
permissions:
contents: read # checkout
uses: Avunu/docusystem/.github/workflows/docs-build.yml@5f97ba8d997b882044ad6d6e7c66dca9194a8422 # v0.1.0
with:
site-directory: docs-site
3 changes: 3 additions & 0 deletions docs-site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules/
dist/
.docusystem/
10 changes: 10 additions & 0 deletions docs-site/docusystem.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"$schema": "./node_modules/@avunu/docusystem/config.schema.json",
"name": "eSign",
"tagline": "Collect electronic signatures on any Frappe or ERPNext document through web forms, with signed PDFs and a full audit trail.",
"slug": "esign",
"platform": "frappe",
"repo": "https://github.com/Avunu/esign",
"domain": "esign-webforms.avunu.net",
"license": "MIT"
}
Loading
Loading