Skip to content

Commit

Permalink
feat: create and list issues
Browse files Browse the repository at this point in the history
  • Loading branch information
Kavitha Kesavalu authored and Kavitha Kesavalu committed Feb 8, 2024
1 parent 69c9330 commit 3b65c3b
Show file tree
Hide file tree
Showing 14 changed files with 9,871 additions and 73 deletions.
2 changes: 1 addition & 1 deletion .prettierrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ module.exports = {
singleQuote: true,
trailingComma: 'es5',
printWidth: 100,
};
};
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@ hooks:
post_checkout: npm install
apply: mv .eslintrc .eslintrc.json
pr_message: echo 'Hey! This PR renames `.eslintrc` to `.eslintrc.json`'
issues:
title: "this is my first updated issue"
description: "this is my first updated issue"
labels: ['ENHANCEMENT', 'BUG']
state: closed
state_reason: completed
```
### Fields
Expand Down Expand Up @@ -127,6 +133,16 @@ Hooks define the core functionality of a migration in Shepherd.
- **Description**: Commands to generate a pull request message.
- **Output**: Anything written to `stdout` is used for the message. Multiple commands will have their outputs concatenated.

- `issue`:
- **Description**: Commands to post, update and close issues.
- **Output**: Depending on the details provided in migration scripts, the issues will be created, updated and closed.

- `list-issue`:
- **Description**: Commands to list all posted issues.
- **Output**: All the posted issues are listed in the table format.



### Requirements

- Optional: `should_migrate`, `post_checkout`
Expand Down Expand Up @@ -167,6 +183,8 @@ There are a number of commands that must be run to execute a migration:
- `pr-preview`: Prints the commit message that would be used for each repository without actually creating a PR; uses the `pr_message` hook.
- `pr`: Creates a PR for each repo with the message generated from the `pr_message` hook.
- `version`: Prints Shepherd version
- `issue`: Create/update/close issues across multiple repository.
- `list-issues`: Lists all posted issues in the table format.

By default, `checkout` will use the adapter to figure out which repositories to check out, and the remaining commands will operate on all checked-out repos. To only checkout a specific repo or to operate on only a subset of the checked-out repos, you can use the `--repos` flag, which specifies a comma-separated list of repos:

Expand Down
Loading

0 comments on commit 3b65c3b

Please sign in to comment.