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

[Suggestion] documentation on updating to use the latest release #31

Closed
tabern opened this issue Mar 2, 2020 · 0 comments · Fixed by #43
Closed

[Suggestion] documentation on updating to use the latest release #31

tabern opened this issue Mar 2, 2020 · 0 comments · Fixed by #43
Labels
documentation Improvements or additions to documentation feature-request New/Enhanced functionality wanted

Comments

@tabern
Copy link
Contributor

tabern commented Mar 2, 2020

Is your feature request related to a problem? Please describe.
We need clear instructions on updating your CDK to the latest release, or a simpler method. Today you have to:

  • update package.json file to the latest release version ("@awslabs/cdk8s": "^0.10.0")
  • run yarn install, yarn build,yarn synth

Describe the solution you'd like
Single shot CLI based solution to use the latest build.

@tabern tabern added feature-request New/Enhanced functionality wanted documentation Improvements or additions to documentation labels Mar 2, 2020
eladb pushed a commit that referenced this issue Mar 5, 2020
Rename the "gen" command to "import" and require an argument that will be used to indicate the spec to import. This will be later used to support importing from other specs like CRDs.

Improvements to the typescript app template:

 - Include `help.txt` with useful commands
 - Add a `compile` command that only runs tic
 - Fix #31 by adding instructions on how to upgrade
 - Create an integration test for `cdk8s init typescript-app`.

Resolves #40

BREAKING CHANGE: `cdk8s gen` is now `cdk8s import k8s` and output goes to `imports/k8s.ts` instead of `.gen/index.ts`.
@eladb eladb closed this as completed in #43 Mar 5, 2020
eladb pushed a commit that referenced this issue Mar 5, 2020
Rename the "gen" command to "import" and require an argument that will be used to indicate the spec to import. This will be later used to support importing from other specs like CRDs.

Improvements to the typescript app template:

 - Include `help.txt` with useful commands
 - Add a `compile` command that only runs tic
 - Fix #31 by adding instructions on how to upgrade
 - Create an integration test for `cdk8s init typescript-app`.

Resolves #40

BREAKING CHANGE: `cdk8s gen` is now `cdk8s import k8s` and output goes to `imports/k8s.ts` instead of `.gen/index.ts`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature-request New/Enhanced functionality wanted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant