Skip to content

Commit 82d615f

Browse files
committed
Working on docs
1 parent 1edac2d commit 82d615f

12 files changed

Lines changed: 12365 additions & 15 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Step packages are an evolution in the development of Octopus steps. Step packages address many of the concerns that made it difficult to implement new functionality as Octopus scaled up in terms of internal team size and external surface area. In particular, step packages are:
2+
3+
* Developed outside the main Octopus code base.
4+
* Tested as isolated and independent projects.
5+
* Distributed on their own independent timelines.
6+
* Independently versioned, with each version able to be run side-by-side.
7+
8+
This sample project provides a starting point for anyone looking to create a new step package. The code in this repository defines a "Hello World" target and step to demonstrate a minimal step package implementation.
9+
10+
## Project directory structure
11+
12+
The directory structure of a step package project is shown below:
13+
14+
* `\`
15+
* `steps`
16+
* `<step-name>`
17+
* `src`
18+
* `targets`
19+
* `<target-name>`
20+
* `src`
21+
* `.eslintignore` - The [ESLint ignore file](https://eslint.org/docs/user-guide/configuring/ignoring-code#the-eslintignore-file).
22+
* `.eslintrc.js` - The [ESLint configuration file](https://eslint.org/docs/user-guide/configuring/).
23+
* `.gitignore` - The [git ignore file](https://git-scm.com/docs/gitignore).
24+
* `.prettierrc` - The [prettier configuration file](https://prettier.io/docs/en/configuration.html).
25+
* `global.d.ts` - The [TypeScript global libraries](https://www.typescriptlang.org/docs/handbook/declaration-files/templates/global-d-ts.html).
26+
* `package.json` - The [Node.js project file](https://nodejs.org/en/knowledge/getting-started/npm/what-is-the-file-package-json/).
27+
* `package-lock.json` - The specific package versions to be retrieved by npm.
28+
* `tsconfig.json` - The [TypeScript compiler options file](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html).

0 commit comments

Comments
 (0)