diff --git a/README.md b/README.md index 1176daa..3ebeb09 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,16 @@ # enable-ci-cd-using-travis This project automatically apply CI/CD for your scalecube project. it apply the relevant script files for ci/cd that will manage the release/snapshoot versions and continusly deploy the artifacts to maven central. +### Before starting you should test your project for deployablilty and releaseablility: -In order to enable CI-CD on your project: +0. Make sure your *default branch* contains a `pom.xml` file +1. Make sure there are **no dependencies on snapshots** in the POMs to be released. However, the project you want to stage must be a **SNAPSHOT** version. +2. Check that your POMs will not lose content when they are rewritten during the release process: +2.1. Verify that all `pom.xml` files have an *SCM* definition. a parent project is sometime not suffice (e.g. in maven modules as git modules) +3. Do a dryRun release: `mvn release:prepare -DdryRun=true` p.s. you may also wish to pass `-DautoVersionSubmodules=true` as this will save you time if your project is multi-module. Follow the warnings or errors during this build. **Fix** any error before enabling the CI on your project. +3.1 Diff the original file `pom.xml` with the one called `pom.xml.tag` to see if the license or any other info has been removed. This has been known to happen if the starting **``** tag is **not** on a single line. The only things that should be different between these files are the **``** and **``** elements. Any other changes you must backport yourself to the original `pom.xml` file and commit before proceeding with the release. + +### In order to enable CI-CD on your project: 0. git clone git@github.com:scalecube/enable-ci-cd-using-travis.git 1. download secrets file. diff --git a/prepend.to.travis.yml b/prepend.to.travis.yml index 9b9146f..fe777ab 100644 --- a/prepend.to.travis.yml +++ b/prepend.to.travis.yml @@ -2,4 +2,5 @@ addons: apt: packages: - libxml-xpath-perl -sudo: required \ No newline at end of file +sudo: required +