chore: initial commit
This commit is contained in:
@@ -0,0 +1,5 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
||||
patreon: mondarth
|
||||
ko_fi: ulenarofmondarth
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: "[BUG]"
|
||||
labels: bug
|
||||
assignees: 'typhonrt'
|
||||
|
||||
---
|
||||
|
||||
**Module Version:** v0.0.0
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Browser:**
|
||||
-
|
||||
|
||||
**Foundry Version:**
|
||||
|
||||
**Game System:**
|
||||
|
||||
**Additional context**
|
||||
Add any other context (like other modules installed) about the problem here.
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
name: Styling
|
||||
about: Request a change or bug related to styles
|
||||
title: ''
|
||||
labels: styling
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
name: Build and Deploy Docs
|
||||
on:
|
||||
workflow_call:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- 'docs/**'
|
||||
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
IMAGE_NAME: ${{ github.repository }}
|
||||
concurrency:
|
||||
group: generate-docs
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
packages: write
|
||||
attestations: write
|
||||
id-token: write
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Extract version from tag without the v
|
||||
id: get-version
|
||||
run: echo "v=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Patch version into docs configuration
|
||||
id: sub_docs_release
|
||||
run: sed -i "s/release\s+=.*/release = '${{steps.get-version.outputs.v}}/'" docs/conf.py
|
||||
|
||||
- name: Build Documentation
|
||||
run: |
|
||||
docker run --rm -v "${{ github.workspace }}/docs":/docs ghcr.io/ulenarofmondarth/sphinx-docs:latest make html
|
||||
cd ./docs/_build/html
|
||||
zip -r ${{ github.workspace }}/documentation-${{ github.ref_name }}.zip .
|
||||
|
||||
- name: Preserve Documentation
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: documentation-${{ github.ref_name}}
|
||||
path: ${{ github.workspace }}/documentation-${{ github.ref_name }}.zip
|
||||
|
||||
- name: Deploy Documentation
|
||||
uses: peaceiris/actions-gh-pages@v4
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: ./docs/_build/html
|
||||
@@ -0,0 +1,98 @@
|
||||
name: Build and Release Module and Documentation
|
||||
|
||||
on:
|
||||
push:
|
||||
tags: [ "v*" ]
|
||||
paths-ignore:
|
||||
- "docs/**"
|
||||
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
IMAGE_NAME: ${{ github.repository }}
|
||||
|
||||
jobs:
|
||||
|
||||
|
||||
build-documentation:
|
||||
uses: ./.github/workflows/build-and-deploy-docs.yml
|
||||
|
||||
|
||||
build:
|
||||
needs:
|
||||
- build-documentation
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
packages: write
|
||||
attestations: write
|
||||
id-token: write
|
||||
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: pnpm/action-setup@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22.x
|
||||
cache: "pnpm"
|
||||
|
||||
- name: Dump
|
||||
env:
|
||||
GHC: ${{ toJson(github) }}
|
||||
run: 'echo "Dump: ${GHC}"'
|
||||
|
||||
- name: Extract version from tag without the v
|
||||
id: get-version
|
||||
run: echo "v=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Test
|
||||
run: pnpm test
|
||||
|
||||
- name: Compile build
|
||||
run: pnpm build
|
||||
|
||||
# Substitute the Manifest and Download URLs in the `module.json`.
|
||||
- name: Substitute Manifest and Download Links For Versioned Ones
|
||||
id: sub_manifest_link_version
|
||||
uses: microsoft/variable-substitution@v1
|
||||
with:
|
||||
files: 'module.json'
|
||||
env:
|
||||
version: ${{steps.get-version.outputs.v}}
|
||||
url: https://github.com/${{github.repository}}
|
||||
readme: https://github.com/${{github.repository}}/blob/master/README.md
|
||||
bugs: https://github.com/${{github.repository}}/issues
|
||||
changelog: https://github.com/${{github.repository}}/releases/latest
|
||||
manifest: https://github.com/${{github.repository}}/releases/latest/download/module.json
|
||||
download: https://github.com/${{github.repository}}/releases/download/${{github.ref_name}}/module.zip
|
||||
|
||||
# Create a zip file with all files required by the module to add to the release.
|
||||
- name: Bundle into ZIP file
|
||||
run: zip -r ./module.zip module.json assets/ dist/ lang/ packs/ LICENSE documentation-${{ github.ref_name }}.zip
|
||||
|
||||
- name: Recover Release Data
|
||||
uses: dawidd6/action-download-artifact@v6
|
||||
with:
|
||||
workflow: bump-version.yml
|
||||
workflow_conclusion: success
|
||||
name: release-${{ github.ref_name }}
|
||||
path: ${{ github.workspace }}/release-${{ github.ref_name }}
|
||||
search_artifacts: true
|
||||
|
||||
|
||||
- name: Release
|
||||
if: ${{ !env.ACT }}
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
body_path: "${{ github.workspace }}/release-${{ github.ref_name }}/release-note.md"
|
||||
tag_name: ${{ github.ref_name }}
|
||||
files: |
|
||||
documentation-${{ github.ref_name }}.zip
|
||||
module.json
|
||||
module.zip
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -0,0 +1,30 @@
|
||||
name: Bump version
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths-ignore:
|
||||
- 'docs/**'
|
||||
|
||||
jobs:
|
||||
bump-version:
|
||||
if: "!startsWith(github.event.head_commit.message, 'bump:')"
|
||||
runs-on: ubuntu-latest
|
||||
name: "Bump version and create changelog with commitizen"
|
||||
steps:
|
||||
- name: Check out
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}"
|
||||
- name: Create bump and changelog
|
||||
uses: commitizen-tools/commitizen-action@master
|
||||
with:
|
||||
github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
|
||||
changelog_increment_filename: release-note.md
|
||||
- name: Preserve Release Note
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: release-v${{ env.REVISION }}
|
||||
path: release-note.md
|
||||
Reference in New Issue
Block a user