Skip to content

Repository files navigation

Repo Setup (Ruby)

Skeleton setup for a repository that uses Ruby Rake tasks, reusable modules, and AI Copilot prompts and instructions. Drop this into any project to get a consistent git workflow, linting, and session logging out of the box.

Setup

./setup.sh

Installs gems via Bundler and configures the environment. Update properties.yml with the local repo path before running tasks.

Project Structure

Gemfile # Gem dependencies (Ruby ~> 3.4.0)
Rakefile # Auto-loads modules/**/*.rb and tasks/**/*.rake
setup.sh # Initial environment setup
properties.yml # Project configuration (repo path, remote)
modules/
shared/ # Shared::Shell, Shared::Properties
repo/ # Repo::Pull, Push, Log, Squash, Rebase
tasks/
aliases.rake # Top-level aliases: rake test, rake fix
repo.rake # repo:pull, push, log, squash, rebase
tests/
ruby.rake # RuboCop lint + autocorrect
yaml.rake # yamllint
.github/
instructions/ # Copilot instructions per concern
prompts/ # /push, /pull, /squash, /rebase prompts
workflows/
tests.yml # CI: RuboCop + yamllint
.vscode/
extensions.json # Recommended VS Code extensions
settings.json # Ruby LSP + Copilot terminal settings

Rake Tasks

rake # List all available tasks
rake test# RuboCop + yamllint
rake fix # RuboCop autocorrect
rake repo:pull # Pull from git remote (stash → pull --rebase → restore)
rake repo:push # Push to git remote (fix → test → commit → push)
rake repo:log # Save a session log to logs/
rake repo:squash # Anchored squash all commits to root + optional force push
rake repo:rebase # Rebase onto remote default branch (optionally squash first)

AI Prompts

PromptCommandDescription
/pushbundle exec rake repo:pushFix, test, commit, and push to git
/pullbundle exec rake repo:pullStash, pull latest, restore stash
/squashbundle exec rake repo:squashAnchored squash all commits to root
/rebasebundle exec rake repo:rebaseRebase onto remote default branch

Modules

ModuleNamespacePurpose
modules/shared/Shared::Shell, Shared::PropertiesShell helpers and properties.yml config reader
modules/repo/Repo::Pull, Repo::Push, Repo::Log, Repo::Squash, Repo::RebaseGit workflow and session logging

See modules/README.md for full details.

CI

GitHub Actions runs RuboCop and yamllint on every push via .github/workflows/tests.yml.

About

Skeleton Setup for a Repo that uses Ruby Tasks with basic AI Prompts and Instructions

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages