SDM for spring-format blog
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.atomist/kubernetes
assets/kubectl
legal
lib
test
.dockerignore
.gitattributes
.gitignore
.npmignore
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Dockerfile
LICENSE
README.md
index.ts
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

spring-format SDM

Atomist software delivery machine (SDM) that uses spring-format to autoformat Java code.

To get this running:

  1. If you don't already have it, install the Atomist CLI by typing npm i -g @atomist/cli. Please refer to the getting started guide at https://atomist.com/developer.html.
  2. Clone the Atomist executable JAR wrapper for spring-format at https://github.com/atomist/spring-format and create the executable JAR by typing mvn package. The executable JAR will be created under /target/ and its name will be of the form spring-format-0.1.0-SNAPSHOT-jar-with-dependencies.jar.
  3. Update index.ts in this project to specify the path on your system to the executable JAR wrapper created in step 1.
  4. Type npm i to install the dependencies of this project
  5. Start the SDM in local mode via atomist start --local.

Software delivery machines enable you to control your delivery process in code. Think of it as an API for your software delivery. See the Atomist documentation for more information on the concept of a software delivery machine and how to create and develop an SDM.

Getting started

See the Developer Quick Start to jump straight to creating an SDM.

Contributing

Contributions to this project from community members are encouraged and appreciated. Please review the Contributing Guidelines for more information. Also see the Development section in this document.

Code of conduct

This project is governed by the Code of Conduct. You are expected to act in accordance with this code by participating. Please report any unacceptable behavior to code-of-conduct@atomist.com.

Documentation

Please see docs.atomist.com for developer documentation.

Connect

Follow @atomist and The Composition blog related to SDM.

Support

General support questions should be discussed in the #support channel in the Atomist community Slack workspace.

If you find a problem, please create an issue.

Development

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

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. Just press the 'Approve' button in the Atomist dashboard or Slack.


Created by Atomist. Need Help? Join our Slack workspace.