Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
b0882c3
📌 [email protected] for development
pboling Aug 31, 2025
f68fed5
➖ appraisal (fork)
pboling Aug 31, 2025
de8bd04
➕ kettle-dev
pboling Aug 31, 2025
51ab325
🔨 binstubs
pboling Aug 31, 2025
42f4d61
⬆️ bundle update --bundler
pboling Aug 31, 2025
f849b6c
🎨 kettle-dev v1.0.25 templating
pboling Sep 1, 2025
763f83f
⬆️ kettle-dev v1.0.26
pboling Sep 1, 2025
292fc94
🎨 kettle-dev v1.0.26 template .env.local.example
pboling Sep 1, 2025
fcef1cf
🏷️ Update RBS types
pboling Sep 1, 2025
5e94b26
📝 Initial version of docs site
pboling Sep 1, 2025
28ddc2d
🚨 Linting
pboling Sep 1, 2025
1712ebf
📝 CHANGELOG.md
pboling Sep 1, 2025
c06ee5b
👷 appraisal2 update
pboling Sep 1, 2025
8fad168
🔥 Remove unused appraisal gemfile
pboling Sep 1, 2025
5f47199
⬆️ kettle-dev v1.0.27
pboling Sep 1, 2025
6ef6cc7
🎨 Template bootstrap by kettle-dev-setup v1.0.27
pboling Sep 2, 2025
50a861f
⬆️ kettle-dev v1.1.0
pboling Sep 2, 2025
d17bbdb
🎨 Template bootstrap by kettle-dev-setup v1.1.0
pboling Sep 2, 2025
570266b
📝 Heading levels alignment
pboling Sep 2, 2025
3819831
🔧 Simplecov config
pboling Sep 2, 2025
31cbc36
⬆️ kettle-dev v1.1.1
pboling Sep 2, 2025
727343c
🎨 Template bootstrap by kettle-dev-setup v1.1.1
pboling Sep 2, 2025
11c49f7
🎨 Updated gem template w/ kettle-dev v1.1.1
pboling Sep 2, 2025
3b55f83
⬆️ rspec-pending_for 0.0.17
pboling Sep 2, 2025
470e5a7
⬆️ kettle-dev v1.1.2
pboling Sep 2, 2025
6ce721a
🎨 Updated gem template w/ kettle-dev v1.1.2
pboling Sep 2, 2025
b4e624d
⬆️ kettle-dev v1.1.3
pboling Sep 2, 2025
d166a93
📝 kettle-dvcs update
pboling Sep 2, 2025
fba039f
🐛 Oops, lol. version_gem ate itself.
pboling Sep 2, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .env.local.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#
# DO NOT EDIT THIS FILE
#
# COPT THIS FILE TO .env.local
#
# That file is ignored by .gitignore. This file is not.
#
export DEBUG=false # do not allow byebug statements (override in .env.local)
export FLOSS_FUNDING_DEBUG=false # extra logging to help diagnose issues (override in .env.local)
export AUTOGEN_FIXTURE_CLEANUP=false # autogenerated gem fixture cleanup after every RSpec run
export GIT_HOOK_FOOTER_APPEND=false
export GIT_HOOK_FOOTER_APPEND_DEBUG=false
export GIT_HOOK_FOOTER_SENTINEL="⚡️ A message from a fellow meat-based-AI ⚡️"
export GITHUB_TOKEN=<your GH PAT, for the GHA console bin/rake ci:act - DO NOT EVER COMMIT IT>
16 changes: 12 additions & 4 deletions .envrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Run any command in this library's bin/ without the bin/ prefix!
# Prefer exe version over binstub
PATH_add exe
PATH_add bin

# Only add things to this file that should be shared with the team.
Expand All @@ -16,18 +18,24 @@ PATH_add bin

### External Testing Controls
export K_SOUP_COV_DO=true # Means you want code coverage
export K_SOUP_COV_COMMAND_NAME="Test Coverage"
# Available formats are html, xml, rcov, lcov, json, tty
export K_SOUP_COV_COMMAND_NAME="RSpec Coverage"
export K_SOUP_COV_FORMATTERS="html,tty"
export K_SOUP_COV_MIN_BRANCH=100 # Means you want to enforce X% branch coverage
export K_SOUP_COV_MIN_LINE=100 # Means you want to enforce X% line coverage
export K_SOUP_COV_FORMATTERS="html,xml,rcov,lcov,json,tty"
export K_SOUP_COV_MIN_BRANCH=78 # Means you want to enforce X% branch coverage
export K_SOUP_COV_MIN_LINE=97 # Means you want to enforce X% line coverage
export K_SOUP_COV_MIN_HARD=true # Means you want the build to fail if the coverage thresholds are not met
export K_SOUP_COV_MULTI_FORMATTERS=true
export K_SOUP_COV_OPEN_BIN= # Means don't try to open coverage results in browser
export MAX_ROWS=1 # Setting for simplecov-console gem for tty output, limits to the worst N rows of bad coverage
export KETTLE_TEST_SILENT=true

# Internal Debugging Controls
export DEBUG=false # do not allow byebug statements (override in .env.local)
export FLOSS_CFG_FUND_DEBUG=false # extra logging to help diagnose issues (override in .env.local)
export FLOSS_CFG_FUND_LOGFILE=tmp/log/debug.log

# Concurrently developing the rubocop-lts suite?
export RUBOCOP_LTS_LOCAL=false

# .env would override anything in this file, if `dotenv` is uncommented below.
# .env is a DOCKER standard, and if we use it, it would be in deployed, or DOCKER, environments,
Expand Down
41 changes: 41 additions & 0 deletions .git-hooks/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
#!/usr/bin/env ruby
# vim: set syntax=ruby

ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)

require "rubygems"
require "bundler/setup"

# External gems
require "gitmoji/regex"

full_text = File.read(ARGV[0])
# Is the first character a GitMoji?
gitmoji_index = full_text =~ Gitmoji::Regex::REGEX
if gitmoji_index == 0
exit 0
else
denied = <<EOM
Oh snap, think again...

______ _______ ___ _______ _______ _______ _______ ______ __
| _ | | | | || || || || || | | |
| | || | ___| | || ___|| ||_ _|| ___|| _ || |
| |_||_ | |___ | || |___ | | | | | |___ | | | || |
| __ || ___| ___| || ___|| _| | | | ___|| |_| ||__|
| | | || |___ | || |___ | |_ | | | |___ | | __
|___| |_||_______||_______||_______||_______| |___| |_______||______| |__|


Did you forget to add a relevant gitmoji? (see https://gitmoji.dev/ for tools)
In this project, a Gitmoji must be the first grapheme of the commit message.
What's a grapheme?
A symbol rendered to be visually identifiable as a single character, but which may be composed of multiple Unicode code points)
Must match: #{Gitmoji::Regex::REGEX.to_s}
#{gitmoji_index ? "Found a gitmoji at character index #{gitmoji_index}... not good enough.\n" : ""}
Example: git commit -m "✨ My excellent new feature"

EOM
puts denied
exit 1
end
8 changes: 8 additions & 0 deletions .git-hooks/commit-subjects-goalie.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
🔖 Prepare release v
🔒️ Checksums for v

# Lines beginning with # are ignored.
# This file is read by .git-hooks/prepare-commit-msg in each project.
# Each line of this file will be matched against the commit subject using `starts_with?`.
# If any `starts_with?` match the project script bin/prepare-commit-msg will run.
# 🔒️ Checksums for v is the standard commit message by stone_checksums.
16 changes: 16 additions & 0 deletions .git-hooks/footer-template.erb.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
⚡️ A message from a fellow meat-based-AI ⚡️
- [❤️] Finely-crafted open-source tools like <%= @gem_name %> (& many more) are a full-time endeavor.
- [❤️] Though I adore my work, it lacks financial sustainability.
- [❤️] Please, help me continue enhancing your tools by becoming a sponsor:
- [💲] https://liberapay.com/pboling/donate
- [💲] https://github.com/sponsors/pboling

<% if ENV["GIT_HOOK_FOOTER_APPEND_DEBUG"] == "true" %>
@pwd = <%= @pwd %>
@gemspecs = <%= @gemspecs %>
@spec = <%= @spec %>
@gemspec_path = <%= @gemspec_path %>
@gem_name <%= @gem_name %>
@spec_name <%= @spec_name %>
@content <%= @content %>
<% end %>
20 changes: 20 additions & 0 deletions .git-hooks/prepare-commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#!/bin/sh

# Fail on error and unset variables
set -eu

# Determine project root as the parent directory of this hook script
PROJECT_ROOT="$(CDPATH= cd -- "$(dirname -- "$0")"/.. && pwd)"

# Run the Ruby hook within the direnv context (if available),
# so ENV from .envrc/.env.local at project root is loaded.
# One of the things .envrc needs to do is add $PROJECT_ROOT/bin/ to the path.
# You should have this line at the top of .envrc
# PATH_add bin
# NOTE: this project needs to also add exe as well,
# but other libraries won't generally need to do that.
if command -v direnv >/dev/null 2>&1; then
exec direnv exec "$PROJECT_ROOT" "kettle-commit-msg" "$@"
else
raise "direnv not found. Local development of this project ($PROJECT_ROOT) with tools from the kettle-dev gem may not work properly. Please run 'brew install direnv'."
fi
4 changes: 2 additions & 2 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ github: [pboling] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g.,
issuehunt: pboling # Replace with a single IssueHunt username
ko_fi: pboling # Replace with a single Ko-fi username
liberapay: pboling # Replace with a single Liberapay username
open_collective: ruby-oauth # Replace with a single Open Collective username
open_collective: ruby-oauth
patreon: galtzo # Replace with a single Patreon username
polar: pboling
thanks_dev: u/gh/pboling
tidelift: rubygems/version_gem # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
tidelift: rubygems/version_gem
7 changes: 3 additions & 4 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@ updates:
- package-ecosystem: bundler
directory: "/"
schedule:
interval: daily
time: "04:36"
open-pull-requests-limit: 10
interval: "weekly"
open-pull-requests-limit: 5
ignore:
- dependency-name: "rubocop-lts"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
interval: "weekly"
14 changes: 9 additions & 5 deletions .github/workflows/ancient.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
name: MRI 2.3, 2.4, 2.5 (EOL)

permissions:
contents: read

on:
push:
branches:
- 'main'
- '*-stable'
tags:
- '!*' # Do not execute on tags
pull_request:
Expand All @@ -20,8 +24,8 @@ concurrency:

jobs:
test:
name: Specs ${{ matrix.ruby }} ${{ matrix.appraisal }}${{ matrix.name_extra || '' }}
if: "!contains(github.event.commits[0].message, '[ci skip]') && !contains(github.event.commits[0].message, '[skip ci]')"
name: Specs ${{ matrix.ruby }} ${{ matrix.appraisal }}${{ matrix.name_extra || '' }}
runs-on: ubuntu-22.04
continue-on-error: ${{ matrix.experimental || endsWith(matrix.ruby, 'head') }}
env: # $BUNDLE_GEMFILE must be set at job level, so it is set for all steps
Expand All @@ -33,23 +37,23 @@ jobs:
# Ruby 2.3
- ruby: "ruby-2.3"
appraisal: "ruby-2-3"
exec_cmd: "rake spec"
exec_cmd: "rake test"
gemfile: "Appraisal.root"
rubygems: "3.3.27"
bundler: "2.3.27"

# Ruby 2.4
- ruby: "ruby-2.4"
appraisal: "ruby-2-4"
exec_cmd: "rake spec"
exec_cmd: "rake test"
gemfile: "Appraisal.root"
rubygems: "3.3.27"
bundler: "2.3.27"

# Ruby 2.5
- ruby: "ruby-2.5"
appraisal: "ruby-2-5"
exec_cmd: "rake spec"
exec_cmd: "rake test"
gemfile: "Appraisal.root"
rubygems: "3.3.27"
bundler: "2.3.27"
Expand All @@ -68,7 +72,7 @@ jobs:

# Raw `bundle` will use the BUNDLE_GEMFILE set to matrix.gemfile (i.e. Appraisal.root)
# We need to do this first to get appraisal installed.
# NOTE: This does not use the main Gemfile at all.
# NOTE: This does not use the primary Gemfile at all.
- name: Install Root Appraisal
run: bundle
- name: Appraisal for ${{ matrix.appraisal }}
Expand Down
21 changes: 21 additions & 0 deletions .github/workflows/auto-assign.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Auto Assign
on:
issues:
types: [opened]
pull_request:
types: [opened]
jobs:
run:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- name: 'Auto-assign issue'
uses: pozil/auto-assign-issue@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
assignees: pboling
abortIfPreviousAssignees: true
allowSelfAssign: true
numOfAssignee: 1
4 changes: 2 additions & 2 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ name: "CodeQL"

on:
push:
branches: [ main, "*-stable" ]
branches: [ main, '*-stable' ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ main, "*-stable" ]
branches: [ main, '*-stable' ]
schedule:
- cron: '35 1 * * 5'

Expand Down
71 changes: 42 additions & 29 deletions .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
name: Test Coverage

permissions:
contents: read
pull-requests: write
id-token: write

env:
K_SOUP_COV_MIN_BRANCH: 100
K_SOUP_COV_MIN_LINE: 100
K_SOUP_COV_MIN_HARD: true
K_SOUP_COV_FORMATTERS: "xml,rcov,lcov,tty"
K_SOUP_COV_DO: true
K_SOUP_COV_COMMAND_NAME: "RSpec Coverage"
K_SOUP_COV_MULTI_FORMATTERS: true
K_SOUP_COV_COMMAND_NAME: "Test Coverage"

on:
push:
branches:
- 'main'
- '*-stable'
tags:
- '!*' # Do not execute on tags
pull_request:
Expand All @@ -19,9 +27,6 @@ on:
# Allow manually triggering the workflow.
workflow_dispatch:

permissions:
contents: read

# Cancels all previous workflow runs for the same branch that have not yet completed.
concurrency:
# The concurrency group contains the workflow name and the branch name.
Expand All @@ -30,8 +35,8 @@ concurrency:

jobs:
coverage:
name: Code Coverage on ${{ matrix.ruby }}@current
if: "!contains(github.event.commits[0].message, '[ci skip]') && !contains(github.event.commits[0].message, '[skip ci]')"
name: Code Coverage on ${{ matrix.ruby }}@current
runs-on: ubuntu-latest
continue-on-error: ${{ matrix.experimental || endsWith(matrix.ruby, 'head') }}
env: # $BUNDLE_GEMFILE must be set at job level, so it is set for all steps
Expand All @@ -43,7 +48,7 @@ jobs:
# Coverage
- ruby: "ruby"
appraisal: "coverage"
exec_cmd: "rake spec"
exec_cmd: "rake test"
gemfile: "Appraisal.root"
rubygems: latest
bundler: latest
Expand All @@ -62,17 +67,45 @@ jobs:

# Raw `bundle` will use the BUNDLE_GEMFILE set to matrix.gemfile (i.e. Appraisal.root)
# We need to do this first to get appraisal installed.
# NOTE: This does not use the main Gemfile at all.
# NOTE: This does not use the primary Gemfile at all.
- name: Install Root Appraisal
run: bundle
- name: Appraisal for ${{ matrix.appraisal }}
run: bundle exec appraisal ${{ matrix.appraisal }} bundle
- name: Tests for ${{ matrix.ruby }}@current via ${{ matrix.exec_cmd }}
run: bundle exec appraisal ${{ matrix.appraisal }} bundle exec ${{ matrix.exec_cmd }}

# Do SaaS coverage uploads first
- name: Upload coverage to Coveralls
if: ${{ !env.ACT }}
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
continue-on-error: ${{ matrix.experimental != 'false' }}

- name: Upload coverage to QLTY
if: ${{ !env.ACT }}
uses: qltysh/qlty-action/coverage@main
with:
token: ${{secrets.QLTY_COVERAGE_TOKEN}}
files: coverage/.resultset.json
continue-on-error: ${{ matrix.experimental != 'false' }}

# Build will fail here if coverage upload fails
# which will hopefully be noticed for the lack of code coverage comments
- name: Upload coverage to CodeCov
if: ${{ !env.ACT }}
uses: codecov/codecov-action@v5
with:
use_oidc: true
fail_ci_if_error: false # optional (default = false)
files: coverage/lcov.info,coverage/coverage.xml
verbose: true # optional (default = false)

# Then PR comments
- name: Code Coverage Summary Report
if: ${{ !env.ACT && github.event_name == 'pull_request' }}
uses: irongut/[email protected]
if: ${{ github.event_name == 'pull_request' }}
with:
filename: ./coverage/coverage.xml
badge: true
Expand All @@ -87,28 +120,8 @@ jobs:

- name: Add Coverage PR Comment
uses: marocchino/sticky-pull-request-comment@v2
if: ${{ github.event_name == 'pull_request' }}
if: ${{ !env.ACT && github.event_name == 'pull_request' }}
with:
recreate: true
path: code-coverage-results.md
continue-on-error: ${{ matrix.experimental != 'false' }}

- name: Upload coverage to Coveralls
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
continue-on-error: ${{ matrix.experimental != 'false' }}

- name: Upload coverage to QLTY
uses: qltysh/qlty-action/coverage@main
with:
coverage-token: ${{secrets.QLTY_COVERAGE_TOKEN}}
files: coverage/.resultset.json
continue-on-error: ${{ matrix.experimental != 'false' }}

- name: Upload coverage to CodeCov
uses: codecov/codecov-action@v5
with:
fail_ci_if_error: true # optional (default = false)
token: ${{ secrets.CODECOV_TOKEN }}
verbose: true # optional (default = false)
Loading
Loading