Skip to content

Commit b2be164

Browse files
committed
feat: validate and fix publication workflow artifacts
1 parent 8fe753f commit b2be164

File tree

15 files changed

+353
-206
lines changed

15 files changed

+353
-206
lines changed

.agent/workflows/publish-change.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
description: Pipeline to test, sanitize, and publish changes to jjConfig
3+
---
4+
5+
### 1. Quality Assurance
6+
7+
Verify that the code meets quality standards and documentation is up to date.
8+
9+
0. Update Documentation Checklist:
10+
- [ ] `TASKS.md`: Mark completed items, add next steps
11+
- [ ] `backups/VERSION_HISTORY.md`: Add version/change notes
12+
- [ ] `README.md`: Update feature list if user-facing changes
13+
14+
1. Check for linting and formatting errors
15+
`trunk check`
16+
17+
2. (Optional) Run AI review for final check
18+
`scripts/ai-review.sh`
19+
20+
### 2. Security & Sanitization
21+
22+
**CRITICAL**: Remove all personal identifiable information (PII) before snapshotting.
23+
24+
// turbo 3. Run the robust sanitization script (includes auto-discovery)
25+
`jj security-sanitize`
26+
27+
### 3. Commit & Publish
28+
29+
Finalize the snapshot and push to the remote.
30+
31+
4. Describe the changes (Write a good commit message)
32+
`jj describe`
33+
34+
5. Push to GitHub (Triggers GitGuardian pre-push hook)
35+
`jj git push`
36+
37+
6. Create the Pull Request
38+
`gh pr create --web`
39+
40+
### 4. Restore Local State
41+
42+
**Important**: Restore your local configuration (email) so you can continue working.
43+
44+
7. Restore PII (Email)
45+
`python3 .build-artifacts/sanitize_email.py --restore`
46+
47+
### 5. Release (After Merge)
48+
49+
Once the PR is approved and merged integration branch:
50+
51+
7. Create a release tag
52+
`gh release create v1.0.0 --generate-notes`

.github/workflows/ggshield.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,24 @@ name: GitGuardian Scan
22

33
on: [push, pull_request]
44

5+
permissions:
6+
contents: read
7+
58
jobs:
69
scanning:
710
name: GitGuardian Scan
811
runs-on: ubuntu-latest
912
steps:
1013
- name: Checkout
11-
uses: actions/checkout@v3
14+
uses: actions/checkout@v4
1215
with:
1316
fetch-depth: 0 # fetch all history so multiple commits can be scanned
1417

1518
- name: GitGuardian scan
16-
uses: GitGuardian/ggshield-action@v1.24.0
19+
uses: GitGuardian/ggshield-action@v1
1720
env:
1821
GITHUB_PUSH_BEFORE_SHA: ${{ github.event.before }}
19-
GITHUB_PUSH_BASE_SHA: ${{ github.event.base_ref }}
22+
GITHUB_PUSH_BASE_SHA: ${{ github.event.before }}
2023
GITHUB_PULL_BASE_SHA: ${{ github.event.pull_request.base.sha }}
2124
GITHUB_DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
2225
GITGUARDIAN_API_KEY: ${{ secrets.GITGUARDIAN_API_KEY }}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,4 @@ backups/v*/applied-*.timestamp
4343

4444
# relay state
4545
/.relay/
46+
.cache_ggshield

.mcp/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
**Repository:** jjConfig
44
**GitHub:** Thomo1318/jjConfig
55
**MCP Server:** https://gitmcp.io/Thomo1318/jjConfig
6-
**Updated:** 2025-12-05T10:03:59Z
6+
**Updated:** 2026-01-01T06:52:31Z
77

88
## Quick Setup
99

@@ -25,5 +25,5 @@ Context files update automatically via Git hooks.
2525

2626
## Status
2727
- Branch:
28-
- Commit: 1a85507dda70e8d1a1748939d0853e8745442284
29-
- Generated: 2025-12-05T10:03:59Z
28+
- Commit: b816691632b5db370256130f3bd670a6f17a9d64
29+
- Generated: 2026-01-01T06:52:31Z

.mcp/context.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
"github_url": "https://github.com/Thomo1318/jjConfig.git",
55
"mcp_url": "https://gitmcp.io/Thomo1318/jjConfig",
66
"is_github_repo": true,
7-
"generated_at": "2025-12-05T10:03:59Z",
7+
"generated_at": "2026-01-01T06:52:31Z",
88
"branch": "",
9-
"commit": "1a85507dda70e8d1a1748939d0853e8745442284",
9+
"commit": "b816691632b5db370256130f3bd670a6f17a9d64",
1010
"mcp_endpoints": {
1111
"readme": "https://gitmcp.io/Thomo1318/jjConfig/readme",
1212
"docs": "https://gitmcp.io/Thomo1318/jjConfig/docs",

.relay/prompts/system-prompt.md

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

CONTRIBUTING.md

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,41 @@ make test
3333

3434
# Deploy to test
3535
make deploy
36-

✏️ Making Changes
37-
Configuration Changes
38-
1. Edit the main config: ⁠config.toml
 2. Add reference files: Place in appropriate subdirectory (⁠aliases/, ⁠revsets/, etc.)
 3. Update documentation: Reflect changes in relevant README files
39-
Documentation Changes
40-
1. Follow markdown best practices
 2. Use proper headings (H1-H6)
 3. Include code examples with syntax highlighting
 4. Add emojis for visual appeal (sparingly)
 5. Test all links
41-
Adding New Features
42-
1. Create reference file in appropriate directory
 2. Add to README in that directory
 3. Update main README if user-facing
 4. Add to TASKS.md if part of roadmap
36+
## ✏️ Making Changes
37+
38+
### The Golden Workflow
39+
40+
Follow this "Inner Loop" to ensure quality and security:
41+
42+
#### 1. The Inner Loop (Iterate)
43+
> **Goal**: Get the code working and documented locally.
44+
1. **Code**: `micro config.toml` (Edit your files)
45+
2. **Test**: `make test` or `trunk check` (Verify immediately)
46+
3. **Docs**: Update `README.md` or `alias/*.md` **in parallel** with code changes.
47+
4. *Repeat until tests pass and docs match code.*
48+
49+
#### 2. Quality Assurance
50+
> **Goal**: Polish before committing.
51+
1. **Formating**: `trunk fmt` (Standardize style)
52+
2. **AI Review**: `scripts/ai-review.sh` (Catch bugs/impovements)
53+
54+
#### 3. Commit & Sanitize
55+
> **Goal**: Secure your work.
56+
1. **Snapshot**: `jj describe -m "feat: description"`
57+
2. **Sanitize**: `jj security-sanitize` (Scrub PII/emails)
58+
* *Critical*: Must run before pushing!
59+
60+
#### 4. Publish
61+
> **Goal**: Share with the world.
62+
1. **Push**: `jj git push`
63+
* *Note*: This triggers the `pre-push` hook (GitGuardian).
64+
2. **PR**: `gh pr create` (Triggers CI/CD)
65+
66+
### Adding New Features
67+
1. Create reference file in appropriate directory
68+
2. Add to README in that directory
69+
3. Update main README if user-facing
70+
4. Add to TASKS.md if part of roadmap
4371
🧪 Testing Changes
4472
Syntax Validation
4573
# Test configuration syntax
@@ -178,4 +206,5 @@ We welcome feature requests! Please include:
178206
Your contributions make jjConfig better for everyone. We appreciate your time and effort!
179207
Happy contributing! 🎉
180208

181-
---
209+
---
210+
```

QUICKSTART.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,5 @@ Need Help?
116116
• Troubleshooting: TROUBLESHOOTING.md
 • Contributing: CONTRIBUTING.md
 • Issues: https://github.com/Thomo1318/jjConfig/issues
 • jj Discord: https://discord.gg/dkmfj3aGQN
117117
Happy hacking! 🎉
118118

119-
---
119+
---
120+
```

0 commit comments

Comments
 (0)