From e466635a1cdb87db03ca1eeacb9b8aa82eb65df3 Mon Sep 17 00:00:00 2001 From: kjuulh Date: Thu, 6 Apr 2023 20:46:57 +0200 Subject: [PATCH] add plan --- README.md | 70 ++++++++++++++++++++++++++++++++++++++++++++ plan.yml | 2 ++ shuttletask/build.go | 7 +++++ 3 files changed, 79 insertions(+) create mode 100644 README.md create mode 100644 plan.yml create mode 100644 shuttletask/build.go diff --git a/README.md b/README.md new file mode 100644 index 0000000..d0ee2ed --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +# clank-shuttle-infrastructure-plan + +The clank-shuttle-infrastructure-plan is a toolkit designed to help quickly set +up infrastructure and support development in Terraform modules, projects, Helm +charts, and more. With the provided OpenAPI specification, + +# Getting Started + +## Initialize the Project + +```bash +shuttle run init +``` + +This command initializes the project, setting up the necessary configurations +and downloading any required dependencies. + +## Build the Project + +```bash +shuttle run build +``` + +This command builds the project, generating the necessary infrastructure and +artifacts. + +## Apply the Changes + +```bash +shuttle run apply +``` + +This command applies the changes to your infrastructure, creating or updating +resources as needed. + +## Format the Code + +```bash +shuttle run format +``` + +This command formats the code, ensuring it adheres to best practices and style +guidelines. + +## Adding Helm Charts + +To add Helm charts to your project, follow these steps: + +1. Create a `templates/charts` directory in your project. +2. Add your Helm charts to the charts directory. +3. Add values in the `templates` directory, i.e. .values.yaml +4. Update your project's YAML file to include the Helm chart settings, if + needed. +5. Use the Shuttle CLI commands mentioned above to build, apply, and manage your + Helm charts along with the rest of your infrastructure. + +# Contributing + +If you'd like to contribute to the clank-shuttle-infrastructure-plan, please +feel free to submit pull requests or open issues to report bugs and suggest new +features. License + +This project is licensed under the MIT License. See the LICENSE file for more +information. + +# Support + +If you encounter any issues or need help with the +clank-shuttle-infrastructure-plan, please reach out to our team or open an issue +on the GitHub repository. diff --git a/plan.yml b/plan.yml new file mode 100644 index 0000000..51bf81b --- /dev/null +++ b/plan.yml @@ -0,0 +1,2 @@ +vars: +scripts: diff --git a/shuttletask/build.go b/shuttletask/build.go new file mode 100644 index 0000000..7e26832 --- /dev/null +++ b/shuttletask/build.go @@ -0,0 +1,7 @@ +package main + +import "context" + +func Build(ctx context.Context) error { + return nil +}