{"id":19339414,"url":"https://github.com/appfolio/ladle","last_synced_at":"2025-06-28T17:34:03.619Z","repository":{"id":44294488,"uuid":"43972433","full_name":"appfolio/ladle","owner":"appfolio","description":"Serves stew to stewards","archived":false,"fork":false,"pushed_at":"2024-02-27T21:35:49.000Z","size":558,"stargazers_count":2,"open_issues_count":21,"forks_count":1,"subscribers_count":130,"default_branch":"master","last_synced_at":"2024-04-16T00:52:00.460Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/appfolio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-10-09T18:16:18.000Z","updated_at":"2024-05-30T01:15:29.136Z","dependencies_parsed_at":"2024-05-30T01:15:17.621Z","dependency_job_id":"deae63d6-57a5-4909-ae11-da8c25af51d1","html_url":"https://github.com/appfolio/ladle","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/appfolio/ladle","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appfolio%2Fladle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appfolio%2Fladle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appfolio%2Fladle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appfolio%2Fladle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appfolio","download_url":"https://codeload.github.com/appfolio/ladle/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appfolio%2Fladle/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262469399,"owners_count":23316314,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T03:22:01.580Z","updated_at":"2025-06-28T17:34:03.599Z","avatar_url":"https://github.com/appfolio.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Circle CI](https://circleci.com/gh/appfolio/ladle.svg?style=svg)](https://circleci.com/gh/appfolio/ladle)\n[![Code Climate](https://codeclimate.com/github/appfolio/ladle/badges/gpa.svg)](https://codeclimate.com/github/appfolio/ladle)\n[![Coverage Status](https://coveralls.io/repos/appfolio/ladle/badge.svg?branch=master\u0026service=github)](https://coveralls.io/github/appfolio/ladle?branch=master)\n[![Codacy Badge](https://api.codacy.com/project/badge/grade/dc9336ede6bf47c688db97a5ff81c07c)](https://www.codacy.com/app/donnie-tognazzini/ladle)\n\nArchived. Consider using [code_ownership](https://github.com/rubyatscale/code_ownership)\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*\n\n- [Ladle](#ladle)\n  - [Usage](#usage)\n    - [Advanced](#advanced)\n  - [Architecture](#architecture)\n    - [Authentication](#authentication)\n    - [Observing Repositories](#observing-repositories)\n  - [Development](#development)\n  - [Deployment](#deployment)\n    - [Heroku](#heroku)\n    - [GitHub Application](#github-application)\n    - [Email Notifications](#email-notifications)\n    - [Restricted Access](#restricted-access)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n# Ladle\n\nAn application for assisting in Appfolio's implementation of code stewardship. Stewards are folks that look after a section of code. Stewardship is opt-in and open to anyone.\n\n## Usage\n\nTo opt-in, add your GitHub username to a `stewards.yml` file anywhere in the directory structure of a repository monitored by Ladle; for example:\n\n  _in app/stewards.yml:_\n  ```yaml\n  stewards:\n    - dhh\n  ```\n\nThis entry states that `dhh` is a steward of everything under _app/_.\n\nTo get notifications anytime any Pull Requests are opened that modify files in _app/_, login to Ladle using your the GitHub user you used in the `stewards.yml` file.\n\nTo remove notifications remove your name from the `stewards.yml` file.\n\n### Advanced \n\nStewards file entries may include per user glob patterns for declaring more detailed targeting. For example:\n\n  _in app/stewards.yml:_\n  ```yaml\n  stewards:\n    - ykatz\n    - github_username: dhh\n      include: \n        - models/*.rb\n        - controllers/*.rb\n      exclude: models/django/*.rb\n  ```\n\nThe above file specifies that `dhh` is a steward of everything under _app/_ matching the `include:` key and not matching the `exclude:` key, while `ykatz` is a steward of everything under _app/_.\n\n## Architecture\n\n### Authentication\n\nUsers are authenticated using [omniauth-github](https://github.com/intridea/omniauth-github). The GitHub [scopes](https://developer.github.com/v3/oauth/#scopes) requested as part of authentication are necessary for Ladle to notify the user. Access is restricted to the [list of configured organizations.](#restricted-access)\n\n### Observing Repositories\n\nRepositories are observed via GitHub [webhooks](https://developer.github.com/v3/repos/hooks/). The code for repositories is accessed via an authorization token associated with a user of the repository. \n\nCurrently, repositories are added manually via the below. In the future, we could build a flow within Ladle for this.\n\n1. Login to Ladle using the GitHub user you want to use to access the repository. The authentication process will create a token that can be used for login, but not for accessing the contents of repositories.\n\n2. Create a [Personal Access Token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) for the user that will be used to access the repository.\n\n3. Via the [Rails console on Heroku](https://devcenter.heroku.com/articles/getting-started-with-rails4#console), save the token created in the previous step for the user from step 1:\n\n  ```ruby\n  user = User.find_by_github_username('dhh')\n  user.token = '\u003cpersonal_access_token\u003e'\n  user.save!\n  ```\n4. Create a [webhook](https://developer.github.com/webhooks/creating/) on the repository listening for the `pull_request` event and using `/github_events/payload` as the payload URL.\n\n5. Via the [Rails console on Heroku](https://devcenter.heroku.com/articles/getting-started-with-rails4#console) create a new `Repository` model:\n\n  ```ruby\n    Repository.create!(name: 'dhh/f-bombs',\n                       webhook_secret: '\u003cwebhook_secret\u003e',\n                       access_via: User.find_by_github_username('dhh'))\n  ```\n\n## Development\n\nSee [development.md](development.md).\n\n## Deployment\n\nThis section describes how Ladle is configured and deployed.\n\n### Heroku\n\nLadle is built to be deployed on Heroku.\n\n### GitHub Application\n\nLadle runs as a GitHub Application. The following ENV variables must be set:\n\n  - `GH_APPLICATION_ID`\n  - `GH_APPLICATION_SECRET`\n  - `TOKEN_KEY` # for encrypting OAuth tokens in the DB\n\n### Email Notifications\n\nLadle uses SendGrid for sending email notifications to stewards. The following ENV variables must be set:\n\n  - `SENDGRID_USERNAME`\n  - `SENDGRID_PASSWORD`\n  - `MAILER_HOST`\n\n### Restricted Access\n\nAccess to a deployed instance is permitted only if the user has access to an organization in the `ALLOWED_ORGANIZATIONS` ENV variable.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappfolio%2Fladle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappfolio%2Fladle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappfolio%2Fladle/lists"}