Skip to content

Commit 091240e

Browse files
brittekbrittek
committed
docs: embed official monogram snippet
1 parent ad6853d commit 091240e

File tree

8 files changed

+203
-63
lines changed

8 files changed

+203
-63
lines changed

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @brittek

‎.github/FUNDING.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: brittek
2+
custom: https://brittek.io/contact

‎.github/SECURITY.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Security fixes are applied to the `main` branch. Deployments derived from this repository should track `main` or cherry-pick patches promptly.
6+
7+
## Reporting a Vulnerability
8+
9+
Please report suspected vulnerabilities by emailing [[email protected]](mailto:[email protected]). Include:
10+
11+
- Detailed description of the issue and potential impact
12+
- Steps to reproduce or proof-of-concept
13+
- Any mitigations already in place
14+
15+
We will acknowledge receipt within 2 business days and provide status updates at least weekly until resolution. Please do not disclose the issue publicly until it has been remediated and coordinated disclosure has been agreed.

‎.github/SUPPORT.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Support
2+
3+
## Need help?
4+
5+
For general questions about Brittek Digital or this repository:
6+
7+
- 📧 Email: [[email protected]](mailto:[email protected])
8+
- 🌐 Website: [https://brittek.io](https://brittek.io)
9+
10+
## Response Times
11+
12+
- Business hours: Monday–Friday, 09:00–17:00 AEST
13+
- Target initial response: within 2 business days
14+
15+
## Bug Reports & Feature Requests
16+
17+
Please open an issue with the appropriate template and include environment details, steps to reproduce, and expected vs. actual behaviour. Sensitive information should be redacted or sent via email.
18+
19+
## Security Issues
20+
21+
Refer to [SECURITY.md](SECURITY.md) for responsible disclosure instructions.

‎.github/workflows/traffic-snapshot.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: traffic-snapshot
2+
3+
on:
4+
schedule:
5+
- cron: '0 2 * * *'
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
snapshot:
13+
if: ${{ secrets.TRAFFIC_PAT != '' }}
14+
runs-on: ubuntu-latest
15+
env:
16+
TRAFFIC_TOKEN: ${{ secrets.TRAFFIC_PAT }}
17+
steps:
18+
- uses: actions/checkout@v4
19+
with:
20+
fetch-depth: 0
21+
persist-credentials: false
22+
- name: Configure git credentials
23+
run: |
24+
git config user.name "github-actions[bot]"
25+
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
26+
git remote set-url origin https://x-access-token:${TRAFFIC_TOKEN}@github.com/${{ github.repository }}.git
27+
- name: Snapshot traffic metrics
28+
env:
29+
REPO: ${{ github.repository }}
30+
run: |
31+
set -euo pipefail
32+
if [ -z "${TRAFFIC_TOKEN}" ]; then
33+
echo "TRAFFIC_PAT secret is not configured; skipping snapshot." >&2
34+
exit 0
35+
fi
36+
DATE="$(date -u +"%Y-%m-%dT%H-%M-%SZ")"
37+
mkdir -p analytics
38+
for endpoint in views clones popular/referrers popular/paths; do
39+
slug="${endpoint//\//-}"
40+
file="analytics/${DATE}-${slug}.json"
41+
echo "Fetching ${endpoint} -> ${file}"
42+
curl -sSf \
43+
-H "Accept: application/vnd.github+json" \
44+
-H "Authorization: Bearer ${TRAFFIC_TOKEN}" \
45+
-H "X-GitHub-Api-Version: 2022-11-28" \
46+
"https://api.github.com/repos/${REPO}/traffic/${endpoint}" | jq '.' > "${file}"
47+
done
48+
if git status --short | grep -q "."; then
49+
git add analytics
50+
git commit -m "chore: snapshot traffic ${DATE}"
51+
BRANCH="${GITHUB_REF##*/}"
52+
git push origin HEAD:"${BRANCH}"
53+
else
54+
echo "No changes to commit"
55+
fi

‎README.md‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
11
<!-- Logo -->
22
<p align="center">
3-
<img src="https://assets.codepen.io/9806267/2%400.5x.png" alt="Brittek Digital Monogram" width="180" height="180" />
3+
<img
4+
src="https://assets.codepen.io/9806267/2_5.png"
5+
alt="Brittek Digital Logo"
6+
width="200"
7+
height="auto"
8+
loading="eager"
9+
style="margin-bottom: 1rem;"
10+
/>
411
</p>
512

613
<h1 align="center">brittek.io</h1>
714
<p align="center"><strong>Brittek Digital — Website front-end, AI-first structured data, and deployment artefacts.</strong></p>
815

16+
> ⚠️ Official Repository — Brittek I/O
17+
> This is the **only** canonical source for the Brittek I/O maintenance site.
18+
> • Website: https://brittek.io
19+
> • Verified domain(s): brittek.io
20+
> • No redistribution / rebranding without written consent
21+
922
---
1023

1124
## TL;DR

‎analytics/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Traffic Snapshots
2+
3+
This directory stores timestamped JSON snapshots of GitHub traffic metrics (views, clones, referrers, and popular paths) captured by the `traffic-snapshot` workflow.
4+
5+
Each file is named using the UTC timestamp of collection and the metric, for example:
6+
7+
```
8+
2024-05-08T02-00-00Z-views.json
9+
2024-05-08T02-00-00Z-clones.json
10+
2024-05-08T02-00-00Z-popular-referrers.json
11+
2024-05-08T02-00-00Z-popular-paths.json
12+
```
13+
14+
> **Note:** The workflow requires a personal access token with `repo` and `traffic` scopes stored as `TRAFFIC_PAT` in the repository secrets. Without this secret the snapshot job will be skipped.

0 commit comments

Comments
 (0)