diff --git a/ci/README.adoc b/ci/README.adoc index c2c154acca9..cb617637d9b 100644 --- a/ci/README.adoc +++ b/ci/README.adoc @@ -1,7 +1,8 @@ == Spring Framework Concourse pipeline -The Spring Framework is using https://concourse-ci.org/[Concourse] for its CI build and other automated tasks. -The Spring team has a dedicated Concourse instance available at https://ci.spring.io. +The Spring Framework uses https://concourse-ci.org/[Concourse] for its CI build and other automated tasks. +The Spring team has a dedicated Concourse instance available at https://ci.spring.io with a build pipeline +for https://ci.spring.io/teams/spring-framework/pipelines/spring-framework-5.3.x[Spring Framework 5.3.x]. === Setting up your development environment @@ -25,13 +26,17 @@ spring https://ci.spring.io spring-framework Wed, 25 Mar 20 ---- === Pipeline configuration and structure + The build pipelines are described in `pipeline.yml` file. + This file is listing Concourse resources, i.e. build inputs and outputs such as container images, artifact repositories, source repositories, notification services, etc. + It also describes jobs (a job is a sequence of inputs, tasks and outputs); jobs are organized by groups. The `pipeline.yml` definition contains `((parameters))` which are loaded from the `parameters.yml` file or from our https://docs.cloudfoundry.org/credhub/[credhub instance]. You'll find in this folder the following resources: + * `pipeline.yml` the build pipeline * `parameters.yml` the build parameters used for the pipeline * `images/` holds the container images definitions used in this pipeline @@ -41,6 +46,7 @@ You'll find in this folder the following resources: === Updating the build pipeline Updating files on the repository is not enough to update the build pipeline, as changes need to be applied. + The pipeline can be deployed using the following command: [source] @@ -48,4 +54,4 @@ The pipeline can be deployed using the following command: $ fly -t spring set-pipeline -p spring-framework-5.3.x -c ci/pipeline.yml -l ci/parameters.yml ---- -NOTE: This assumes that you have credhub integration configured with the appropriate secrets. \ No newline at end of file +NOTE: This assumes that you have credhub integration configured with the appropriate secrets.