nhcarrigan/ephemere
9
0
Fork 0
generated from nhcarrigan/template
Code Issues Pull Requests Actions Releases Activity

feat: reorganise bash scripts and add comprehensive documentation #6

Merged
naomi merged 5 commits from feat/more-cohort into main 2026-02-23 20:18:42 -08:00
Conversation 0 Commits 5 Files Changed 65
+4507 -157
hikari commented 2026-02-23 20:04:51 -08:00
Owner
Copy Link
Copy Source

Summary

This PR completes the bash script restructuring and adds comprehensive documentation across all script categories.

Bash Restructuring

  • Moved cohort shell scripts (remove_github_members.sh, update_github_teams.sh) from python/cohort/ into a new bash/cohort/ directory
  • Moved existing bash utilities (add-keys-to-git.sh, fix-yubikey-perms.sh, list-yubikey-ssh-keys.sh) into a new bash/yubikey/ subdirectory
  • Updated run.sh to support Bash as a third language option alongside TypeScript and Python
    • Bash scripts are run directly (no 1Password secret injection needed)
    • Category discovery and script listing works the same as for TS/Python
    • Removed dead "Root Scripts" logic that was no longer needed

Documentation

Added README.md files for all script categories that were missing them:

  • bash/cohort/README.md — cohort GitHub team management scripts
  • bash/yubikey/README.md — YubiKey SSH key and permission utilities
  • typescript/src/crowdin/README.md — Crowdin translation management scripts
  • typescript/src/discord/README.md — Discord bot utility scripts
  • typescript/src/discourse/README.md — Discourse forum management scripts
  • typescript/src/gitea/README.md — Gitea bulk repository operation scripts
  • typescript/src/github/README.md — GitHub API interaction scripts
  • typescript/src/music/README.md — Music file metadata tools
  • typescript/src/s3/README.md — S3-compatible object storage scripts
  • typescript/src/security/README.md — Security analysis and reporting scripts
  • python/cohort/README.md — Updated to remove moved shell scripts, fix usage commands

Also updated project-level docs:

  • README.md — Corrected project structure, fixed running instructions (removed references to non-existent make run-ts/make run-py targets), added Bash prerequisites
  • CLAUDE.md — Updated project overview, structure, development standards, and script-adding guides to reflect the current state of the project

✨ This PR was created with help from Hikari~ 🌸

## Summary This PR completes the bash script restructuring and adds comprehensive documentation across all script categories. ### Bash Restructuring - Moved cohort shell scripts (`remove_github_members.sh`, `update_github_teams.sh`) from `python/cohort/` into a new `bash/cohort/` directory - Moved existing bash utilities (`add-keys-to-git.sh`, `fix-yubikey-perms.sh`, `list-yubikey-ssh-keys.sh`) into a new `bash/yubikey/` subdirectory - Updated `run.sh` to support **Bash** as a third language option alongside TypeScript and Python - Bash scripts are run directly (no 1Password secret injection needed) - Category discovery and script listing works the same as for TS/Python - Removed dead "Root Scripts" logic that was no longer needed ### Documentation Added `README.md` files for all script categories that were missing them: - `bash/cohort/README.md` — cohort GitHub team management scripts - `bash/yubikey/README.md` — YubiKey SSH key and permission utilities - `typescript/src/crowdin/README.md` — Crowdin translation management scripts - `typescript/src/discord/README.md` — Discord bot utility scripts - `typescript/src/discourse/README.md` — Discourse forum management scripts - `typescript/src/gitea/README.md` — Gitea bulk repository operation scripts - `typescript/src/github/README.md` — GitHub API interaction scripts - `typescript/src/music/README.md` — Music file metadata tools - `typescript/src/s3/README.md` — S3-compatible object storage scripts - `typescript/src/security/README.md` — Security analysis and reporting scripts - `python/cohort/README.md` — Updated to remove moved shell scripts, fix usage commands Also updated project-level docs: - **`README.md`** — Corrected project structure, fixed running instructions (removed references to non-existent `make run-ts`/`make run-py` targets), added Bash prerequisites - **`CLAUDE.md`** — Updated project overview, structure, development standards, and script-adding guides to reflect the current state of the project ✨ This PR was created with help from Hikari~ 🌸
hikari added 5 commits 2026-02-23 20:04:51 -08:00
feat: port remaining cohort scripts and make reusable 4fdb5d06f1 
- Port 19 cohort scripts from /home/naomi/docs/cohort/
- Replace all hardcoded tokens and dotenv usage with os.environ
- Add pandas==3.0.1 dependency
- Add E501 to ruff ignore list for Discord message string content
- Make remove_resigned_members.py reusable (empty RESIGNED_IDS constant)
- Make update_roster_messages.py reusable (iterates all teams from JSON)
- Exclude 12 one-off/event-specific scripts as non-reusable
docs: add data file documentation and fix data path resolution a40188413a 
All Python cohort scripts now use DATA_DIR = Path(__file__).parent.parent.parent / "data"
to correctly resolve the repo-root data/ directory regardless of the working directory
set by run.sh. All TypeScript scripts have expanded JSDoc headers documenting data file
requirements and environment variables.
chore: add documentation todo tracker c4b9f795d9
refactor: reorganise bash scripts into subdirectories and add bash runner support b0620f2af3 
Move yubikey scripts from bash/ root into bash/yubikey/, move cohort shell
scripts from python/cohort/ into bash/cohort/, and update run.sh to support
Bash as a third language with category-based script discovery.
docs: add README files for all script categories and update project docs
CI / dependency-pin-check-typescript (pull_request) Successful in 5s
Details
CI / dependency-pin-check-python (pull_request) Successful in 4s
Details
Security Scan and Upload / Security & DefectDojo Upload (pull_request) Successful in 57s
Details
CI / python (pull_request) Successful in 9m33s
Details
CI / typescript (pull_request) Successful in 9m41s
Details
ae081cb54c 
Add Getting Started sections and correct usage commands to all category
READMEs (TypeScript, Python, Bash). Update top-level README.md and
CLAUDE.md to reflect the Bash language, correct project structure, and
accurate make run instructions. Remove completed DOCS_TODO.md.
naomi merged commit ec58c9c843 into main 2026-02-23 20:18:42 -08:00
naomi deleted branch feat/more-cohort 2026-02-23 20:18:42 -08:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
aspect
code
Concerns the software code in the repository
aspect
dx
Concerns developers' experience with the codebase
aspect
interface
Concerns end-users' experience with the software
aspect
text
Concerns the documentation material in the repository
contribute
good first issue
A great opportunity for a team member to learn a new codebase
contribute
help wanted
Open for anyone on our team to grab.
contribute
staff only
Restricted to our executive leadership.
goal
addition
Addition of new feature
goal
fix
Bug fix
goal
improvement
Improvement to an existing feature
points
1
Very simple issue requiring minimal effort and complexity.
points
13
Extremely complex issue representing major undertakings. Should be broken down into smaller pieces.
points
2
Simple issue that requires a bit more thought or investigation.
points
3
Moderate complexity issue requiring more substantial work.
points
5
Complex issue requiring significant effort and expertise.
points
8
Very complex issue requiring extensive work and deep expertise.
priority
critical
1
Must be fixed ASAP
priority
high
2
Stalls work on the project or its dependents
priority
low
4
Low priority and doesn't need to be rushed
priority
medium
3
Not blocking but should be fixed soon
priority
none
5
No priority, should only be performed when a developer is available
status
awaiting triage
Has not been triaged & therefore, not ready for work
status
blocked
Blocked and therefore not ready for work
status
discarded
Will not be worked on
status
discontinued
Not suitable for work as repo is in maintenance
status
label work required
Needs proper labelling before it can be worked on
status
ready for dev
Ready for work
status
ticket work required
Needs more details before it can be worked on
talk
discussion
Open for discussions and feedback
talk
question
Can be resolved with an answer
time
1 day
Approximately one full day of development work.
time
1-2 weeks
One to two weeks of focused development effort.
time
2-3 days
Two to three days of development effort.
time
4-5 days
Approximately one week of development work.
time
<1 day
Less than one day of focused work. Quick fixes or simple tasks.
time
>2 weeks
More than two weeks of development work. Must be broken down into smaller pieces.
No Label
Milestone
No items
No Milestone
Assignees
Clear assignees
gurkirat hanna (Hanna Rose) hikari (Hikari) minori (Minori) naomi (Naomi Carrigan) rain teklu tim
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: nhcarrigan/ephemere#6
Delete Branch "feat/more-cohort"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?