Shiftstack Bugwatcher

A collection of scripts to assist us in triaging our bugs.

make build

pretriage

Usage:

./pretriage

Finds untriaged, unassigned Shiftstack bugs and assigns them to a team member.

Required environment variables:

• JIRA_TOKEN: a Jira API token of an account that can access the OCPBUGS project
• SLACK_HOOK: a Slack hook URL
• PEOPLE: an address book. It is a YAML object in the form:

- kerberos: user1
  github_handle: ghuser
  jira_name: jirauser
  slack_id: U012334
- kerberos: user2
  github_handle: ghuser2
  jira_name: jirauser2
  slack_id: U0122345

• TEAM: an object containing team members, referencing the kerberos property of PEOPLE. It is a YAML object in the form:

user1:
  bug_triage: true
  leave:
  - start: 2024-11-21
    end: 2025-02-28

Local testing

A local script will set the required environment variables for you if you provide a vault token.

export VAULT_TOKEN=$vault_token
make run-pretriage

triage

Usage:

./triage

Reminds assignees about the bugs assigned to them for triage.

Required environment variables:

• JIRA_TOKEN: a Jira API token of an account that can access the OCPBUGS project
• SLACK_HOOK: a Slack hook URL
• PEOPLE and TEAM described [above][pretriage].

posttriage

Usage:

./posttriage

Resets the Triaged keyword on bugs that still need attention.

Required environment variables:

• JIRA_TOKEN: a Jira API token of an account that can access the OCPBUGS project

doctext

Usage:

./doctext

Finds resolved bugs lacking a doc text, and posts a reminder to Slack.

Required environment variables:

• JIRA_TOKEN: a Jira API token of an account that can access the OCPBUGS project
• SLACK_HOOK: a Slack hook URL
• PEOPLE and TEAM described [above][pretriage].