Skip to content

Commit e3ae2c1

Browse files
SunDevil311SunDevil311
authored
Feature/major update (#1)
## Types of changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Breaking change (fix or feature that would cause existing functionality to change) ## Description - Migration to Material for MkDocs - New workflows borrowed from `netwk-pro/blog` ## Checklist <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [x] I have read and followed the guidelines in the **[CONTRIBUTING](https://github.com/netwk-pro/.github/blob/master/.github/CONTRIBUTING.md)** document. - [x] I've checked for existing Pull Requests for the same update/change. - [x] My code follows the project’s coding style. - [x] My code has been linted locally before submission. - [x] All new and existing tests pass. &nbsp; - [x] I have updated the documentation accordingly. - [ ] I have added tests to cover my changes, if applicable. *(Optional, especially for new contributors)* Pull requests are part of a collaborative process — we welcome contributions and review each one carefully. For all but the smallest changes, you can expect maintainers to request improvements or clarifications. Please check back after opening your PR and be responsive to feedback so we can get your contribution merged quickly. Thanks for helping improve Network Pro Strategies!
2 parents 3cf596e + e22cf83 commit e3ae2c1

37 files changed

+2915
-1396
lines changed

‎.browserslistrc‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
# SPDX-License-Identifier: CC-BY-4.0 OR GPL-3.0-or-later
2-
# This file is part of Network Pro.
3-
#
4-
# Supported browsers
5-
61
defaults and fully supports es6-module
72
maintained node versions
83
last 2 node major versions

‎.editorconfig‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1+
# =========================================================================
12
# SPDX-License-Identifier: CC-BY-4.0 OR GPL-3.0-or-later
23
# This file is part of Network Pro.
34
#
45
# EditorConfig helps developers define and maintain consistent
56
# coding styles between different editors and IDEs
67
# See http://editorconfig.org/ for full details
8+
# =========================================================================
79

810
; top-most EditorConfig file
911
root = true

‎.gitattributes‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# =========================================================================
12
# SPDX-License-Identifier: CC-BY-4.0 OR GPL-3.0-or-later
23
# This file is part of Network Pro.
34
#
@@ -10,7 +11,7 @@
1011
# binary These files are binary and should be left untouched.
1112
#
1213
# Note that binary is a macro for -text -diff.
13-
######################################################################
14+
# =========================================================================
1415

1516
## AUTO-DETECT
1617
## Handle line endings automatically for files detected as

‎.github/.gitkeep‎

Whitespace-only changes.

‎.github/COMMIT_GUIDE.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<!-- =====================================================================
2+
.github/COMMIT_GUIDE.md
3+
4+
Copyright © 2025 Network Pro Strategies (Network Pro™)
5+
SPDX-License-Identifier: CC-BY-4.0 OR GPL-3.0-or-later
6+
This file is part of Network Pro.
7+
====================================================================== -->
8+
9+
# Commit Message Guide
10+
11+
To maintain clarity and consistency, use one of the following commit types when
12+
writing messages. Keep them short and focused — the `CHANGELOG.md` remains the
13+
source of truth for full details.
14+
15+
## Commit Types
16+
17+
| Type | Description |
18+
| ----------- | ------------------------------------------------------------ |
19+
| `feat:` | A new feature or enhancement |
20+
| `fix:` | A bug fix |
21+
| `chore:` | Tooling, build scripts, release prep, or other meta changes |
22+
| `docs:` | Documentation-only changes |
23+
| `style:` | Formatting or stylistic changes that don't affect behavior |
24+
| `refactor:` | Code changes that restructure without changing functionality |
25+
| `test:` | Adding or updating tests |
26+
27+
## Examples
28+
29+
- `feat: add cryptomator entry to FOSS spotlight`
30+
- `fix: correct author metadata in app.html`
31+
- `chore: prepare v1.13.8 release`
32+
- `docs: update changelog for v1.13.8`
33+
- `style: clean up indentation in layout.svelte`
34+
- `refactor: split utility functions from helpers.js`
35+
- `test: add unit tests for buildPath util`
36+
37+
---
38+
39+
Stick to one type per commit when possible. For mixed changes, pick the most
40+
meaningful one.
41+
42+
Consistency helps, but don’t overthink it — use what makes sense.
43+
44+
<!-- cspell:ignore cryptomator -->

‎.github/FUNDING.yml‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎.github/workflows/auto-assign.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# .github/workflows/auto-assign.yml
2+
#
3+
# Copyright © 2025 Network Pro Strategies (Network Pro™)
4+
# SPDX-License-Identifier: CC-BY-4.0 OR GPL-3.0-or-later
5+
# This file is part of Network Pro
6+
#
7+
# This workflow will auto-assign an issue or PR to a specific user
8+
# when a new issue or PR is opened.
9+
10+
name: Auto Assign
11+
12+
on:
13+
issues:
14+
types: [opened]
15+
pull_request:
16+
types: [opened, edited, synchronize, reopened]
17+
18+
permissions:
19+
issues: write
20+
contents: read
21+
pull-requests: write
22+
23+
jobs:
24+
auto-assign:
25+
runs-on: ubuntu-24.04
26+
27+
steps:
28+
- name: 'Auto-assign issue or PR'
29+
uses: pozil/auto-assign-issue@v2
30+
with:
31+
repo-token: ${{ secrets.GITHUB_TOKEN }}
32+
assignees: SunDevil311
33+
numOfAssignee: 1
34+
allowSelfAssign: true
35+
36+
# cspell:ignore pozil

‎.github/workflows/backup-branch.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# .github/workflows/backup-branch.yml
2+
#
3+
# Syncs backup/nightly-snapshot branch with master every day at 10:00 UTC.
4+
# Only triggers on the default branch and not on PRs
5+
#
6+
# Copyright © 2025 Network Pro Strategies (Network Pro™)
7+
# SPDX-License-Identifier: CC-BY-4.0 OR GPL-3.0-or-later
8+
# This file is part of Network Pro
9+
10+
name: Nightly Backup Branch Sync
11+
12+
on:
13+
schedule:
14+
- cron: '0 11 * * *' # Every day at 11:00 AM UTC (4:00 AM MST)
15+
workflow_dispatch: # Allow manual triggering too
16+
17+
permissions:
18+
contents: write
19+
20+
jobs:
21+
sync-backup:
22+
name: Sync backup/nightly-snapshot to master
23+
runs-on: ubuntu-24.04
24+
if: github.ref == 'refs/heads/master' && github.event_name != 'pull_request'
25+
26+
steps:
27+
- name: Checkout master branch
28+
uses: actions/checkout@v5
29+
with:
30+
ref: master
31+
fetch-depth: 0 # Required to push to another branch
32+
33+
- name: Set up Git
34+
run: |
35+
git config user.name "SunDevil311"
36+
git config user.email "[email protected]"
37+
38+
- name: Force-push to backup/nightly-snapshot
39+
run: |
40+
git push --force origin HEAD:refs/heads/backup/nightly-snapshot

‎.github/workflows/build-and-deploy.yml‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# .github/workflows/build-and-deploy.yml
2+
#
3+
# Copyright © 2025 Network Pro Strategies (Network Pro™)
4+
# SPDX-License-Identifier: CC-BY-4.0 OR GPL-3.0-or-later
5+
# This file is part of Network Pro
6+
7+
name: Build Site and Deploy to GH Pages
8+
9+
on:
10+
release:
11+
types: [created]
12+
workflow_dispatch:
13+
14+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
15+
permissions:
16+
actions: read
17+
contents: read
18+
pages: write
19+
id-token: write
20+
21+
# Allow one concurrent deployment
22+
concurrency:
23+
group: 'pages'
24+
cancel-in-progress: true
25+
26+
jobs:
27+
check-codeql:
28+
uses: ./.github/workflows/check-codeql.yml
29+
30+
build:
31+
needs: check-codeql
32+
runs-on: ubuntu-24.04
33+
34+
steps:
35+
- name: Checkout repository
36+
uses: actions/checkout@v5
37+
with:
38+
fetch-depth: 0
39+
40+
- name: Set up Node.js
41+
uses: actions/setup-node@v5
42+
with:
43+
node-version: 22
44+
cache: npm
45+
cache-dependency-path: package-lock.json
46+
47+
- name: Upgrade npm
48+
run: |
49+
corepack enable
50+
npm install -g [email protected]
51+
52+
- name: Set up Pages
53+
uses: actions/configure-pages@v5
54+
55+
- name: Install Node.js dependencies
56+
run: npm ci
57+
58+
# Begin Material for MkDocs setup
59+
- name: Set up Python
60+
uses: actions/setup-python@v6
61+
with:
62+
python-version: '3.13'
63+
64+
- name: Install Python dependencies
65+
run: pip install -r requirements.txt
66+
67+
# Strict mode disabled for mkdocs-material
68+
- name: Build MkDocs documentation
69+
run: mkdocs build
70+
71+
- name: Copy package.json to build directory
72+
run: cp package.json build/
73+
74+
- name: Upload artifact
75+
uses: actions/upload-pages-artifact@v4
76+
with:
77+
path: ./build
78+
79+
deploy:
80+
needs: [check-codeql, build]
81+
environment:
82+
name: github-pages
83+
url: ${{ steps.deployment.outputs.page_url }}
84+
runs-on: ubuntu-24.04
85+
86+
steps:
87+
- name: Deploy to GitHub Pages
88+
id: deployment
89+
uses: actions/deploy-pages@v4

‎.github/workflows/check-codeql.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# .github/workflows/check-codeql.yml
2+
#
3+
# Copyright © 2025 Network Pro Strategies (Network Pro™)
4+
# SPDX-License-Identifier: CC-BY-4.0 OR GPL-3.0-or-later
5+
# This file is part of Network Pro
6+
7+
name: CodeQL Status Check
8+
9+
permissions:
10+
actions: read
11+
contents: read
12+
13+
on:
14+
workflow_call:
15+
16+
jobs:
17+
check:
18+
name: Check CodeQL Status
19+
runs-on: ubuntu-24.04
20+
21+
steps:
22+
- name: Check CodeQL Workflow
23+
env:
24+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
25+
run: |
26+
gh --version
27+
28+
if ! gh run list --repo "${GITHUB_REPOSITORY}" --workflow "CodeQL" --limit 1 --json conclusion --jq '.[0].conclusion' > codeql_status.txt; then
29+
echo "::error title=CodeQL Check Failed::Could not retrieve CodeQL run status. Blocking deployment."
30+
exit 1
31+
fi
32+
33+
CODEQL_STATUS=$(cat codeql_status.txt)
34+
echo "CodeQL status: $CODEQL_STATUS"
35+
if [[ "$CODEQL_STATUS" != "success" ]]; then
36+
echo "::error title=CodeQL Check Failed::Latest CodeQL run did not succeed. Blocking deployment."
37+
exit 1
38+
fi
39+
40+
rm -f codeql_status.txt

0 commit comments

Comments
 (0)