maven-jenkins-ci-demo

KO | EN

gitlite — search

#python #ai #typescript #go #android #rust #deep-learning #macos #java #nodejs #windows #awesome-list #openai #open-source

maven-jenkins-ci-demo

(★ 20)

No description available.

maven-jenkins-ci-demo Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Continuous Integration for Apigee Proxies using Maven

### Read the docs [here](https://apigee.github.io/maven-jenkins-ci-demo)

[![CI for Apigee Proxies](https://raw.githubusercontent.com/apigee/maven-jenkins-ci-demo/master/docs-src/images/apigee-ci.png)](https://apigee.github.io/maven-jenkins-ci-demo)

The Objective of this project is to provide a containerised Jenkins image, prepackaged with required plugins and Apigee Jobs. This should not be used for a production setup, instead please refer to the Jenkins [Documentation](https://jenkins.io/doc/book/installing/).

This is not an officially supported Google product.

## Components

### Sample Apigee Proxy - Currency API

Project contains a sample proxy for a currency API that retrieves exchange rates
for a base currency using [fixer.io](http://fixer.io) API as the target.

See [Currency API OpenAPI Specification](./docs-src/currency-v1.yaml) for more
information on northbound api design.

The following best practices are demonstrated:

*   Error handling - [Community
    Article](https://community.apigee.com/content/kbentry/23724/an-error-handling-pattern-for-apigee-proxies.html)

*   Supporting Parallel Development on an API Proxy - [Community
    Article](https://community.apigee.com/content/kbentry/26716/api-proxy-team-development-with-maven.html)

*   Commit data in proxy description. See [pom](./currency-v1/pom.xml#L171).

[pomxmlsnippet](docs-src/images/pomxml sample snippet.png)

*   Unit testing - [Community
    Article](https://community.apigee.com/articles/3964/unit-testing-javascript-code-with-mocha-sinon-and.html).

*   Integration testing with BDD and apickli - see [feature
    file](./currency-v1/test/integration/features/rates.feature).

See [maven phases](./docs-src/maven-phases.md) document to understand pom structure.

### Dockerfile

Project contains a [Dockerfile](./Dockerfile) that can be used to create
a Jenkins image ready to start deploying currency api.

Docker implementation performs the following operations:

*   Jenkins plugin installation - check out the [list of plugins
    installed](./docker/jenkins/plugins)

*   Setup build jobs - see [jobs folder](./docker/jenkins/jobs)

*   Configure maven settings

*   Configure ssh for github authentication

*   Install node.js and npm

Read the [Jenkins build pipeline](./docs-src/jenkins-pipeline.md) to understand how
pipeline is configured for this demonstration.

Read the [setup instructions](./docs-src/setup.md) for step-by-step instructions on
how to setup the whole CI process using the sample proxy and Dockerfile.

maven-jenkins-ci-demo

maven-jenkins-ci-demo Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

maven-jenkins-ci-demo

maven-jenkins-ci-demo Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README