Skip to content

Commit 3d114e6

Browse files
TMHSDigitalTMHSDigital
committed
feat: add example .env file and update .gitignore for environment files
Introduced a new example .env file to guide users on setting up their Steam Web API key. Updated .gitignore to ensure the example file is not ignored, allowing it to be included in the repository. Enhanced README with additional CI workflows for better project management. Made-with: Cursor
1 parent 2ab1936 commit 3d114e6

7 files changed

Lines changed: 102 additions & 21 deletions

File tree

‎.env.example‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Steam Web API key (required for player lookups, owned games, leaderboards)
2+
# Get yours free at https://steamcommunity.com/dev/apikey
3+
# STEAM_API_KEY=your_32_char_hex_key_here

‎.github/workflows/ci.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- name: Set up Python
16+
uses: actions/setup-python@v5
17+
with:
18+
python-version: '3.12'
19+
20+
- name: Install test dependencies
21+
run: pip install -r requirements-test.txt
22+
23+
- name: Run test suite
24+
run: pytest tests/ -v --tb=short

‎.github/workflows/codeql.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: CodeQL
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
schedule:
9+
- cron: '0 6 * * 1'
10+
11+
jobs:
12+
analyze:
13+
name: Analyze
14+
runs-on: ubuntu-latest
15+
permissions:
16+
security-events: write
17+
actions: read
18+
contents: read
19+
strategy:
20+
fail-fast: false
21+
matrix:
22+
language: [python]
23+
steps:
24+
- uses: actions/checkout@v4
25+
26+
- name: Initialize CodeQL
27+
uses: github/codeql-action/init@v3
28+
with:
29+
languages: ${{ matrix.language }}
30+
31+
- name: Autobuild
32+
uses: github/codeql-action/autobuild@v3
33+
34+
- name: Perform CodeQL Analysis
35+
uses: github/codeql-action/analyze@v3
36+
with:
37+
category: '/language:${{ matrix.language }}'

‎.github/workflows/dependency-review.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Dependency Review
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
7+
permissions:
8+
contents: read
9+
pull-requests: write
10+
11+
jobs:
12+
dependency-review:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
17+
- name: Dependency Review
18+
uses: actions/dependency-review-action@v4
19+
with:
20+
fail-on-severity: high
21+
comment-summary-in-pr: always

‎.github/workflows/validate.yml‎

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -103,14 +103,3 @@ jobs:
103103
rule_count=$(ls rules/*.mdc 2>/dev/null | wc -l)
104104
echo "Skills: $skill_count"
105105
echo "Rules: $rule_count"
106-
107-
- name: Set up Python
108-
uses: actions/setup-python@v5
109-
with:
110-
python-version: '3.12'
111-
112-
- name: Install test dependencies
113-
run: pip install -r requirements-test.txt
114-
115-
- name: Run test suite
116-
run: pytest tests/ -v --tb=short

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Environment and secrets
22
.env
33
.env.*
4+
!.env.example
45
*.ssfn
56

67
# Steam credentials

‎README.md‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,22 @@
99
</p>
1010

1111
<p align="center">
12-
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/actions/workflows/validate.yml"><img src="https://img.shields.io/github/actions/workflow/status/TMHSDigital/Steam-Cursor-Plugin/validate.yml?label=CI" alt="CI"></a>
13-
<a href="LICENSE"><img src="https://img.shields.io/badge/license-CC--BY--NC--ND--4.0-blue.svg" alt="License: CC BY-NC-ND 4.0"></a>
14-
<a href="CHANGELOG.md"><img src="https://img.shields.io/badge/version-1.0.0-green.svg" alt="Version"></a>
15-
<a href="https://www.npmjs.com/package/@tmhs/steam-mcp"><img src="https://img.shields.io/npm/v/@tmhs/steam-mcp?label=MCP%20server" alt="npm version"></a>
16-
<a href="https://www.npmjs.com/package/@tmhs/steam-mcp"><img src="https://img.shields.io/npm/dw/@tmhs/steam-mcp?label=MCP%20downloads" alt="npm downloads"></a>
17-
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/stargazers"><img src="https://img.shields.io/github/stars/TMHSDigital/Steam-Cursor-Plugin?style=flat" alt="GitHub Stars"></a>
18-
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/commits/main"><img src="https://img.shields.io/github/last-commit/TMHSDigital/Steam-Cursor-Plugin" alt="Last Commit"></a>
19-
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin"><img src="https://img.shields.io/badge/Cursor-Plugin-8B5CF6.svg" alt="Cursor Plugin"></a>
20-
<a href="https://partner.steamgames.com/doc/webapi"><img src="https://img.shields.io/badge/Steam_Web_API-1b2838.svg?logo=steam&logoColor=white" alt="Steam Web API"></a>
21-
<a href="https://github.com/sponsors/TMHSDigital"><img src="https://img.shields.io/badge/Sponsor-ea4aaa.svg?logo=githubsponsors&logoColor=white" alt="Sponsor"></a>
12+
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/releases/latest"><img src="https://img.shields.io/github/v/release/TMHSDigital/Steam-Cursor-Plugin?style=flat-square&color=1b2838&label=release" alt="Release"></a>
13+
<a href="https://www.npmjs.com/package/@tmhs/steam-mcp"><img src="https://img.shields.io/npm/v/@tmhs/steam-mcp?style=flat-square&color=66c0f4&label=npm" alt="npm version"></a>
14+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-CC--BY--NC--ND--4.0-2a475e?style=flat-square" alt="License: CC BY-NC-ND 4.0"></a>
15+
<a href="https://tmhsdigital.github.io/Steam-Cursor-Plugin/"><img src="https://img.shields.io/badge/docs-website-66c0f4?style=flat-square" alt="Docs"></a>
16+
</p>
17+
18+
<p align="center">
19+
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/TMHSDigital/Steam-Cursor-Plugin/ci.yml?branch=main&style=flat-square&label=CI" alt="CI"></a>
20+
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/actions/workflows/validate.yml"><img src="https://img.shields.io/github/actions/workflow/status/TMHSDigital/Steam-Cursor-Plugin/validate.yml?branch=main&style=flat-square&label=validate" alt="Validate"></a>
21+
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/actions/workflows/codeql.yml"><img src="https://img.shields.io/github/actions/workflow/status/TMHSDigital/Steam-Cursor-Plugin/codeql.yml?branch=main&style=flat-square&label=CodeQL" alt="CodeQL"></a>
22+
</p>
23+
24+
<p align="center">
25+
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/stargazers"><img src="https://img.shields.io/github/stars/TMHSDigital/Steam-Cursor-Plugin?style=flat-square&color=2a475e" alt="Stars"></a>
26+
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/issues"><img src="https://img.shields.io/github/issues/TMHSDigital/Steam-Cursor-Plugin?style=flat-square&color=2a475e" alt="Issues"></a>
27+
<a href="https://www.npmjs.com/package/@tmhs/steam-mcp"><img src="https://img.shields.io/npm/dw/@tmhs/steam-mcp?style=flat-square&color=2a475e&label=downloads" alt="npm downloads"></a>
2228
</p>
2329

2430
---

0 commit comments

Comments
 (0)