# @atomist/sdm-pack-cloudfoundry

> Atomist SDM extension pack for Cloud Foundry

Latest version **1.0.3** (published 2019-03-20) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @atomist/sdm-pack-cloudfoundry
pnpm add @atomist/sdm-pack-cloudfoundry
yarn add @atomist/sdm-pack-cloudfoundry
bun add @atomist/sdm-pack-cloudfoundry
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-03-20 |
| First published | 2018-08-15 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 11 |
| Unpacked size | 322 KB |
| Known vulnerabilities | 0 (+25 in 2 direct dependencies) |
| Install scripts | no |
| Author | Atomist |
| Maintainers | atomist |
| Keywords | atomist, automation, sdm, extension, pack, cloud, cloudfoundry |

## Links

- npm: https://www.npmjs.com/package/@atomist/sdm-pack-cloudfoundry
- Repository: https://github.com/atomist/sdm-pack-cloudfoundry
- Homepage: https://github.com/atomist/sdm-pack-cloudfoundry#readme
- Issues: https://github.com/atomist/sdm-pack-cloudfoundry/issues
- npm.io page: https://npm.io/package/@atomist/sdm-pack-cloudfoundry

## Dependencies (11)

- [axios](https://npm.io/package/axios.md) ^0.18.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.10
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.12.0
- [request](https://npm.io/package/request.md) ^2.87.0
- [archiver](https://npm.io/package/archiver.md) ^2.1.1
- [cf-client](https://npm.io/package/cf-client.md) ^0.13.26
- [form-data](https://npm.io/package/form-data.md) ^2.3.2
- [random-word](https://npm.io/package/random-word.md) ^2.0.0
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.116
- [@atomist/microgrammar](https://npm.io/package/@atomist/microgrammar.md) ^1.2.0
- [@atomist/slack-messages](https://npm.io/package/@atomist/slack-messages.md) ^1.1.0

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2019-03-20
- 2.0.0-master.20190916033253 (branch-master) — 2019-09-16
- 0.1.0-atomist-update-next-1535374612326.20180827125657 (branch-atomist-update-next-1535374612326) — 2018-08-27
- 2.0.0-atomist.a260p86nh.typescript-version.master.20190915213127 — 2019-09-15
- 2.0.0-master.20190910083125 — 2019-09-10
- 2.0.0-atomist.a260p86nh.sdm-deps.master.20190909204233 — 2019-09-09
- 2.0.0-master.20190709172113 — 2019-07-09
- 2.0.0-atomist-update-latest-20190709164013.20190709165133 — 2019-07-09
- 2.0.0-master.20190708202345 — 2019-07-08
- 2.0.0-atomist-update-latest-20190708194523.20190708195036 — 2019-07-08
- 2.0.0-master.20190430144214 — 2019-04-30
- 2.0.0-master.20190430143959 — 2019-04-30
- 2.0.0-new-api.20190430122319 — 2019-04-30
- 1.0.4-master.20190429163656 — 2019-04-29
- 2.0.0-new-api.20190409204636 — 2019-04-09
- … 106 more at https://npm.io/package/@atomist/sdm-pack-cloudfoundry/versions

## README

# @atomist/sdm-pack-cloudfoundry

[![atomist sdm goals](http://badge.atomist.com/T29E48P34/atomist/sdm-pack-cloudfoundry/067b98ed-775a-4d34-a4a3-82837feca109)](https://app.atomist.com/workspace/T29E48P34)
[![npm version](https://img.shields.io/npm/v/@atomist/sdm-pack-cloudfoundry.svg)](https://www.npmjs.com/package/@atomist/sdm-pack-cloudfoundry)

[Atomist][atomist] software delivery machine (SDM) extension pack for
an Atomist SDM to deploy to [Cloud Foundry][cf].  These capabilities
will work for both open source and Pivotal Cloud Foundry.

[cf]: https://www.cloudfoundry.org/ (Cloud Foundry)

See the [Atomist documentation][atomist-doc] for more information on
what SDMs are and what they can do for you using the Atomist API for
software.

[atomist-doc]: https://docs.atomist.com/ (Atomist Documentation)

## Usage

Install the dependency in your SDM project.

```
$ npm install @atomist/sdm-pack-cloudfoundry
```

Then use its exported method to add the functionality to your SDM in
your machine definition.

```typescript
import {
    SoftwareDeliveryMachine,
    SoftwareDeliveryMachineConfiguration,
} from "@atomist/sdm";
import {
    createSoftwareDeliveryMachine,
} from "@atomist/sdm-core";
import {
    CloudFoundrySupport,
} from "@atomist/sdm-pack-cloudfoundry";

export function machine(configuration: SoftwareDeliveryMachineConfiguration): SoftwareDeliveryMachine {
    const sdm = createSoftwareDeliveryMachine({
        name: "My Software Delivery Machine",
        configuration,
    });
    sdm.addExtensionPacks(SeedSupport);
    sdm.addDeployRules(
        deploy.when(IsMaven)
            .deployTo(ProductionDeploymentGoal, ProductionEndpointGoal, ProductionUndeploymentGoal)
            .using({
                deployer: new CloudFoundryBlueGreenDeployer(configuration.sdm.projectLoader),
                targeter: () => new EnvironmentCloudFoundryTarget("production"),
            }),
    );
    return sdm;
};
```

Finally, add the required configuration values to your client
configuration.

```json
{
  "sdm": {
    "cloudfoundry": {
      "user": "cf-user@atomist.com",
      "password": "cFpAsSw0rD",
      "org": "cf-organiation",
      "spaces": {
        "staging": "cf-staging-space",
        "production": "cf-production-space"
      }
    }
  }
}
```

## Support

General support questions should be discussed in the `#support`
channel in the [Atomist community Slack workspace][slack].

If you find a problem, please create an [issue][].

[issue]: https://github.com/atomist/sdm-pack-cloudfoundry/issues

## Development

You will need to install [Node.js][node] to build and test this
project.

[node]: https://nodejs.org/ (Node.js)

### Build and test

Install dependencies.

```
$ npm install
```

Use the `build` package script to compile, test, lint, and build the
documentation.

```
$ npm run build
```

### Release

Releases are handled via the [Atomist SDM][atomist-sdm].  Just press
the 'Approve' button in the Atomist dashboard or Slack.

[atomist-sdm]: https://github.com/atomist/atomist-sdm (Atomist Software Delivery Machine)

---

Created by [Atomist][atomist].
Need Help?  [Join our Slack workspace][slack].

[atomist]: https://atomist.com/ (Atomist - How Teams Deliver Software)
[slack]: https://join.atomist.com/ (Atomist Community Slack)

---
_Source: https://npm.io/package/@atomist/sdm-pack-cloudfoundry · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
