npm-cli-github-issue-tower-defence-management


Welcome to npm-cli-github-issue-tower-defence-management :tada:

Usage 🛠️

Here's how you can use github-issue-tower-defence-management:

``
Usage: github-issue-tower-defence-management [options]

CLI tool for GitHub Issue Tower Defence Management

Options:
-t, --trigger Trigger type: issue or schedule
-c, --config Path to config YAML file
-i, --issue GitHub Issue URL
-h, --help display help for command
`

Example 📖

Here's a quick example to illustrate its usage:

`
npx github-issue-tower-defence-management -t schedule -c ./config.yml
`

`
npx github-issue-tower-defence-management -t issue -c ./config.yml -i https://github.com/HiromiShikata/test-repository/issues/1
`

Config

The config.yaml must match the input type of HandleScheduledEventUseCase.run(). Below is the structure:

`yaml
org: string # Organization name
projectUrl: string # URL of the target project
manager: string # GitHub account name of the manager
workingReport:
repo: string # Repository name
members: # Array of member's GitHub account names
- string
- string
warningThresholdHour?: number # Optional: Warning threshold in hours
spreadsheetUrl: string # URL of the Google Spreadsheet
reportIssueTemplate?: string # Optional: Template for issue reports
reportIssueLabels: # Array of issue labels
- string
- string
`

Example:

`yaml
org: 'my-org'
projectUrl: 'https://github.com/orgs/my-org/projects/1'
manager: 'HiromiShikata'
workingReport:
repo: 'work-report'
members:
- 'HiromiShikata'
- 'octokit'
warningThresholdHour: 40
spreadsheetUrl: 'https://docs.google.com/spreadsheets/d/xxx'
reportIssueTemplate: |
## Working Time Report

### Summary
Period: {period}
Team: {team}

### Details
{details}
reportIssueLabels:
- 'report'
- 'working-time'
slack:
userToken: 'xoxp-xxx'
``

$3

#### scope

- channels:read
- groups:read
- mpim:read
- im:read
- chat:write
- identify
- usergroups:read
- users:read
- files:write
- files:read

Contributing

See CONTRIBUTING.md

License

MIT