diff options
Diffstat (limited to '.travis/README.md')
-rw-r--r-- | .travis/README.md | 35 |
1 files changed, 27 insertions, 8 deletions
diff --git a/.travis/README.md b/.travis/README.md index c737b5aba0..df68c1d4b2 100644 --- a/.travis/README.md +++ b/.travis/README.md @@ -27,6 +27,7 @@ installations of netdata. Jobs are run on following operating systems: - ubuntu 16.04 (containerized) - CentOS 6 (containerized) - CentOS 7 (containerized) + - alpine (containerized) ### Release @@ -41,15 +42,33 @@ Releases are generated by searching for a keyword in last commit message. Keywor All keywords MUST be surrounded with square braces. Alternative is to push a tag to master branch. -### Packages +### Packaging -As a name might suggest, this stage is responsible for creating netdata packages such as: +This stage is executed only on "master" branch and it is separated into 3 jobs: + - Update Changelog/Create release + - Nightly tarball and self-extractor build + - Nightly docker images + +##### Update Changelog/Create release + +This job is running one script called `releaser.sh`, which is responsible for a couple of things. First of all it +automatically updates our CHANGELOG.md file based on GitHub features (mostly labels and pull requests). Apart from +that it can also create a new git tag and a github draft release connected to that tag. +Releases are generated by searching for a keyword in last commit message. Keywords are: + - `[patch]` or `[fix]` to bump patch number + - `[minor]`, `[feature]` or `[feat]` to bump minor number + - `[major]` or `[breaking change]` to bump major number +All keywords MUST be surrounded with square brackets. + +Alternatively new release can be also created by pushing new tag to master branch. + +##### Nightly tarball and self-extractor build AND Nightly docker images + +As names might suggest those two jobs are responsible for nightly netdata package creation and are run every day (in +cron). Combined they produce: - docker images - - tar repository (soon to be removed) + - tar.gz archive (soon to be removed) - self-extracting package -This stage is separated into 2 parallel jobs. One creating docker images and second one creating github artifacts. -Whole stage is executed only on master branch, but there are also additional parameters assigned to jobs: - - docker images - execution only on cron job or when there is a tag assigned starting with `v` - - artifacts - script responsible for creating artifacts doesn't have special conditions, but deployment to GitHub - releases is done only when there is tag assigned +Currently "Nightly tarball and self-extractor build" is using old firehol script and it is planed to be replaced with +new design. |