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

Release cycle and dependency tracking #1

Open
6 tasks
yegortokmakov opened this issue Jan 19, 2024 · 0 comments
Open
6 tasks

Release cycle and dependency tracking #1

yegortokmakov opened this issue Jan 19, 2024 · 0 comments

Comments

@yegortokmakov
Copy link
Contributor

To allow users track updates to this guidance and have proper versioning in their deployment pipelines, we need to define a release cycle for new versions of this repository. My suggestion is to bundle the guidance as a public NPM package. This will give users ability to lock-in specific version and more deployment flexibility.

For example, if we expose CDK in the package, users can install specific version with npm install cdk-galaxy@v1.1.1 and do cdk-galaxy cdk deploy.

Another option is to import specific stack from this guidance, e.g. import ApplicationStack from cdk-galaxy, and use it in user managed CDK application similar to what we have in bin/galaxy.ts.

It would still be possible to clone the repo and use it as is, of course.

  • Add Github actions to build and publish the NPM package under cdk-galaxy
  • Lock down npm dependencies of this repo + setup dependabot
  • Lock down version of the galaxy helm chart (ideally, we should find a way to get something similar to dependabot for it)
  • Expose stacks in the npm package
  • Update the documentation to reflect the latest changes
  • Release the NPM package following semver starting with v1.0.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant