Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(migrate): add README #13935

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions packages/amplify-migration/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Usage

### Codegen

In Gen1 root directory run the following to generate Gen2 code based on Gen1 configuration:

`npx @aws-amplify/migrate to-gen-2 generate-code`

Once this command runs successfully, the Gen1 project is converted to Gen2 with `amplify` directory containing Gen2 code and `.amplify/migration/amplify` containing Gen1 configuration.


Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import { Argv, CommandModule } from 'yargs';
// import { execute, generateTemplates } from '../../../';

export type Gen2GenerateTemplatesCommandOptions = Record<string, never>;

/**
* Command that generates CloudFormation templates needed for stack refactor operation to move resources from Gen1 to Gen2.
*/
export class Gen2GenerateTemplatesCommand implements CommandModule<object, Gen2GenerateTemplatesCommandOptions> {
/**
* @inheritDoc
*/
readonly command: string;

/**
* @inheritDoc
*/
readonly describe: string;

constructor() {
this.command = 'generate-templates';
this.describe = 'Generates stack refactor inputs (CFN templates) to move Gen1 resources to Gen2 applications.';
}

builder = (yargs: Argv): Argv => {
return yargs.version(false);
};
handler = async (): Promise<void> => {
// await generateTemplates();
};
}
Loading