This GitHub Action suite adds a Test-Driven Development (TDD) feedback question to new pull requests and stores the responses in a Google Sheet upon PR closure. It helps track TDD usage and developer experiences across projects.
- Automatically adds a TDD feedback question to new pull requests
- Collects responses when a pull request is closed
- Stores feedback data in a Google Sheet for easy analysis
In order to read and write from the TDD Metrics Spreadsheet the GitHub organistion or repository needs the following secrets:
GOOGLE_SHEETS_CREDENTIALSGOOGLE_SHEET_ID
These have been added at the Boost organisation level, so you shouldn't need to do anything for this to work. If you need them for any reason, they are also stored in 1Password.
- Create a new file
.github/workflows/tdd-question.ymlin your repository with the following content:
name: Add TDD Questionon:
pull_request:
types: [opened]jobs:
add-tdd-question:
if: github.event_name == 'pull_request' && github.event.action == 'opened'runs-on: boost-eks-github-runnerssteps:
- name: Add TDD Questionuses: boost/tdd-action/.github/actions/add-tdd-question@mainwith:
github-token: ${{ secrets.GITHUB_TOKEN }}- Create a new file
.github/workflows/tdd-feedback-capture.ymlin your repository with the following content:
name: Capture TDD Feedbackon:
pull_request:
types: [closed]jobs:
store-tdd-data:
if: github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == trueruns-on: boost-eks-github-runnerssteps:
- name: Store TDD Datauses: boost/tdd-action/.github/actions/store-tdd-data@mainwith:
github-token: ${{ secrets.GITHUB_TOKEN }}google-credentials: ${{ secrets.GOOGLE_SHEETS_CREDENTIALS }}sheet-id: ${{ secrets.TDD_SHEET_ID }}