diff --git a/README.md b/README.md index 11ccd7d..5c7e41f 100644 --- a/README.md +++ b/README.md @@ -14,26 +14,24 @@ The directory structure of a step package project is shown below: * `\` * `steps` - A directory containing the step definitions. * `` - A directory containing the definition of a step. There may be many of these directories to define many steps within a single step package. - * `src` - The directory containing the step source and configuration. - * `__tests__` - The directory containing step tests. - * `executor.spec.ts` - Tests validating the logic in the `executor.ts` file. - * `executor.ts` - The code to be executed when a step is run by Octopus. - * `inputs.ts` - The definition of the inputs required by the step. - * `logo.svg` - The image to be displayed in the Octopus web UI for the step. - * `metadata.json` - The step metadata. - * `ui.ts` - The step UI definition. - * `validation.ts` - The step validation rules. + * `__tests__` - The directory containing step tests. + * `executor.spec.ts` - Tests validating the logic in the `executor.ts` file. + * `executor.ts` - The code to be executed when a step is run by Octopus. + * `inputs.ts` - The definition of the inputs required by the step. + * `logo.svg` - The image to be displayed in the Octopus web UI for the step. + * `metadata.json` - The step metadata. + * `ui.ts` - The step UI definition. + * `validation.ts` - The step validation rules. * `targets` * `` - * `src` - * `__tests__` - The directory containing step tests. - * `executor.spec.ts` - Tests validating the logic in the `executor.ts` file. - * `executor.ts` - The code to be executed when a target healthcheck is run by Octopus. - * `inputs.ts` - The definition of the inputs required by the target. - * `logo.svg` - The image to be displayed in the Octopus web UI for the target. - * `metadata.json` - The target metadata. - * `ui.ts` - The target UI definition. - * `validation.ts` - The target validation rules. + * `__tests__` - The directory containing step tests. + * `executor.spec.ts` - Tests validating the logic in the `executor.ts` file. + * `executor.ts` - The code to be executed when a target healthcheck is run by Octopus. + * `inputs.ts` - The definition of the inputs required by the target. + * `logo.svg` - The image to be displayed in the Octopus web UI for the target. + * `metadata.json` - The target metadata. + * `ui.ts` - The target UI definition. + * `validation.ts` - The target validation rules. * `.eslintignore` - The [ESLint ignore file](https://eslint.org/docs/user-guide/configuring/ignoring-code#the-eslintignore-file). * `.eslintrc.js` - The [ESLint configuration file](https://eslint.org/docs/user-guide/configuring/). * `.gitignore` - The [git ignore file](https://git-scm.com/docs/gitignore). diff --git a/steps/hello-world/src/__tests__/executor.spec.ts b/steps/hello-world/__tests__/executor.spec.ts similarity index 100% rename from steps/hello-world/src/__tests__/executor.spec.ts rename to steps/hello-world/__tests__/executor.spec.ts diff --git a/steps/hello-world/src/executor.ts b/steps/hello-world/executor.ts similarity index 84% rename from steps/hello-world/src/executor.ts rename to steps/hello-world/executor.ts index c6c376d..aa89fda 100644 --- a/steps/hello-world/src/executor.ts +++ b/steps/hello-world/executor.ts @@ -1,6 +1,6 @@ import HelloWorldStepInputs from "./inputs"; import {ExecutionInputs, Handler, OctopusContext, TargetInputs} from "@octopusdeploy/step-api"; -import HelloWorldTargetInputs from "../../../targets/hello-world-target/src/inputs"; +import HelloWorldTargetInputs from "../../targets/hello-world-target/inputs"; const HelloWorldStepExecutor: Handler = async ( inputs: ExecutionInputs, diff --git a/steps/hello-world/src/inputs.ts b/steps/hello-world/inputs.ts similarity index 100% rename from steps/hello-world/src/inputs.ts rename to steps/hello-world/inputs.ts diff --git a/steps/hello-world/src/logo.svg b/steps/hello-world/logo.svg similarity index 100% rename from steps/hello-world/src/logo.svg rename to steps/hello-world/logo.svg diff --git a/steps/hello-world/src/metadata.json b/steps/hello-world/metadata.json similarity index 100% rename from steps/hello-world/src/metadata.json rename to steps/hello-world/metadata.json diff --git a/steps/hello-world/src/ui.ts b/steps/hello-world/ui.ts similarity index 100% rename from steps/hello-world/src/ui.ts rename to steps/hello-world/ui.ts diff --git a/steps/hello-world/src/validation.ts b/steps/hello-world/validation.ts similarity index 100% rename from steps/hello-world/src/validation.ts rename to steps/hello-world/validation.ts diff --git a/targets/hello-world-target/src/executor.ts b/targets/hello-world-target/executor.ts similarity index 100% rename from targets/hello-world-target/src/executor.ts rename to targets/hello-world-target/executor.ts diff --git a/targets/hello-world-target/src/inputs.ts b/targets/hello-world-target/inputs.ts similarity index 100% rename from targets/hello-world-target/src/inputs.ts rename to targets/hello-world-target/inputs.ts diff --git a/targets/hello-world-target/src/logo.svg b/targets/hello-world-target/logo.svg similarity index 100% rename from targets/hello-world-target/src/logo.svg rename to targets/hello-world-target/logo.svg diff --git a/targets/hello-world-target/src/metadata.json b/targets/hello-world-target/metadata.json similarity index 100% rename from targets/hello-world-target/src/metadata.json rename to targets/hello-world-target/metadata.json diff --git a/targets/hello-world-target/src/ui.ts b/targets/hello-world-target/ui.ts similarity index 100% rename from targets/hello-world-target/src/ui.ts rename to targets/hello-world-target/ui.ts diff --git a/targets/hello-world-target/src/validation.ts b/targets/hello-world-target/validation.ts similarity index 100% rename from targets/hello-world-target/src/validation.ts rename to targets/hello-world-target/validation.ts