feat: create and list issues

.prettierrc.js

@@ -2,4 +2,4 @@ module.exports = {
   singleQuote: true,
   trailingComma: 'es5',
   printWidth: 100,
-};
+};

README.md

@@ -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
@@ -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**: Command to create, update, or close issues.
+  - **Output**: Depending on the details provided in migration scripts, the issues will be created, updated or closed.
+
+- `list-issues`:
+  - **Description**: Commands to list all issues associated with a migration.
+  - **Output**: All the posted issues are listed in the table format.
+
+
+
 ### Requirements
 
 - Optional: `should_migrate`, `post_checkout`
@@ -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, or close issues across multiple repository.
+- `list-issues`: List all issues associated with a migration.
 
 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:
 

package.json

@@ -62,6 +62,7 @@
     "@types/js-yaml": "^4.0.9",
     "chalk": "^4.1.2",
     "child-process-promise": "^2.2.1",
+    "table": "^6.8.1",
     "commander": "^11.1.0",
     "fs-extra": "^11.2.0",
     "joi": "^17.11.0",

src/adapters/adapter.mock.ts

@@ -21,6 +21,8 @@ const mockAdapter: IRepoAdapter = {
   getDataDir: jest.fn() as unknown as (repo: IRepo) => string,
   getBaseBranch: jest.fn() as unknown as (repo: IRepo) => string,
   getEnvironmentVariables: jest.fn() as unknown as (repo: IRepo) => Promise<IEnvironmentVariables>,
+  createIssue: jest.fn() as unknown as (repo: IRepo) => Promise<string>,
+  updateIssue: jest.fn() as unknown as (repo: IRepo) => Promise<void>,
 };
 
 export default mockAdapter;

src/adapters/base.ts

@@ -2,6 +2,10 @@ export interface IRepo {
   [key: string]: any;
 }
 
+export interface IssueTracker {
+  [key: string]: any;
+}
+
 export interface IEnvironmentVariables {
   [key: string]: string;
 }
@@ -40,6 +44,10 @@ interface IRepoAdapter {
   getBaseBranch(repo: IRepo): string;
 
   getEnvironmentVariables(repo: IRepo): Promise<IEnvironmentVariables>;
+
+  createIssue(repo: IRepo): Promise<string>;
+
+  updateIssue(repo: IRepo, issueNumber: number): Promise<void>;
 }
 
 export default IRepoAdapter;

src/adapters/git.ts

@@ -94,6 +94,10 @@ abstract class GitAdapter implements IRepoAdapter {
 
   protected abstract getRepositoryUrl(repo: IRepo): string;
 
+  public abstract createIssue(repo: IRepo): Promise<string>;
+
+  public abstract updateIssue(repo: IRepo, issueNumber: number): Promise<void>;
+
   protected git(repo: IRepo): any {
     return simpleGit(this.getRepoDir(repo));
   }

src/adapters/github.ts

@@ -312,6 +312,43 @@ class GithubAdapter extends GitAdapter {
     return `git@${gitHubEnterpriseBaseUrl}:${repo.owner}/${repo.name}.git`;
   }
 
+  public createIssue = async (repo: IRepo): Promise<string> => {
+    const {
+      migration: { spec },
+    } = this.migrationContext;
+    const { owner, name } = repo;
+    const { issues } = spec;
+    //Create an issue with the title , issue message and labels
+
+    return await this.githubService.createAndGetIssueNumber({
+      owner,
+      repo: name,
+      title: issues?.title || 0,
+      body: issues?.description,
+      labels: issues?.labels,
+    });
+  };
+
+  public updateIssue = async (repo: IRepo, issueNumber: number): Promise<void> => {
+    const {
+      migration: { spec },
+    } = this.migrationContext;
+    const { owner, name } = repo;
+    const { issues } = spec;
+
+    //Update an issue's title , issue message and labels
+    await this.githubService.updateIssue({
+      owner,
+      repo: name,
+      title: issues?.title?.toString(),
+      issue_number: issueNumber,
+      body: issues?.description,
+      labels: issues?.labels,
+      state: issues?.state,
+      state_reason: issues?.state_reason,
+    });
+  };
+
   private async checkActionSafety(repo: IRepo): Promise<SafetyStatus> {
     const { owner, name } = repo;
 

src/cli.ts

@@ -22,7 +22,8 @@ import prStatus from './commands/pr-status';
 import push from './commands/push';
 import reset from './commands/reset';
 import version from './commands/version';
-
+import issue from './commands/issue';
+import listIssues from './commands/list-issues';
 import ConsoleLogger from './logger';
 
 const program = new Command();
@@ -152,6 +153,10 @@ addCommand('pr-status', 'Check the status of all PRs for the specified migration
 // These commands don't take --repos arguments
 addCommand('list', 'List all checked out repositories for the given migration', false, list);
 
+addCommand('issue', 'open an issue for the specified repos', true, issue);
+
+addCommand('list-issues', 'List all opened issues using migration', true, listIssues);
+
 program
   .command('version')
   .description('Print Shepherd version')