ec3852160d
* Add support for filtering by changelog type for testing instructions, and remove some warnings * Update readme * Remove error log * Add changelog |
||
|---|---|---|
| .. | ||
| bin | ||
| Application.php | ||
| Config.php | ||
| README.md | ||
| SetGithubCredentialsCommand.php | ||
| WriteCommand.php | ||
README.md
Test Instruction Logger
Test Instruction Logger retrieves test instructions from the PRs in the changelog.txt and writes them into TESTING-INSTRUCTION.md.
Prerequisites
Test Instruction Logger requires Github username and a personal access token to use the Github REST API.
- Follow this guide to create a new personal access token.
- Run
npm run test-instruction-logger github-credentials. Enter your Github username and the perosnal access token. The data will be saved in$HOME/.wca-test-instruction-logger.json
Writing to TESTING-INSTRUCTION.md
- Update the
changelog.txt - Run
npm run test-instruction-logger -- write :version. - Verify
TESTING-INSTRUCTION.md.
Options
types
A comma seperated list of changelog types to retrieve the testing instructions from.
npm run test-instruction-logger -- write :version --types=enhancement,add
save-to
Allows you to save the testing instructions to a different file. Default: TESTING-INSTRUCTIONS.md
npm run test-instruction-logger -- write :version --save-to=instructions.md