summaryrefslogtreecommitdiffstats
path: root/.travis/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--.travis/README.md60
1 files changed, 34 insertions, 26 deletions
diff --git a/.travis/README.md b/.travis/README.md
index 5a51b2a7c..e37e9feff 100644
--- a/.travis/README.md
+++ b/.travis/README.md
@@ -29,40 +29,43 @@ installations of netdata. Jobs are run on following operating systems:
- CentOS 7 (containerized)
- alpine (containerized)
-### Release
+### Packaging
This stage is executed only on "master" brach and allows us to create a new tag just looking at git commit message.
-It also has an option to automatically generate changelog based on GitHub labels and sync it with GitHub release.
-For the sake of simplicity and to use travis features this stage cannot be integrated with next stage.
-
-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 braces.
-Alternative is to push a tag to master branch.
-
-### Packaging
+It executes one script called `releaser.sh` which is responsible for creating a release on GitHub by using
+[hub](https://github.com/github/hub). This script is also executing other scripts which can also be used in other
+CI jobs:
+ - `tagger.sh`
+ - `generate_changelog.sh`
+ - `build.sh`
+ - `create_artifacts.sh`
-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
+Alternatively new release can be also created by pushing new tag to master branch.
-##### Update Changelog/Create release
+##### tagger.sh
-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:
+Script responsible to find out what will be the next tag based on a keyword in last commit message. Keywords are:
- `[netdata patch release]` to bump patch number
- `[netdata minor release]` to bump minor number
- `[netdata major release]` to bump major number
+ - `[netdata release candidate]` to create a new release candidate (appends or modifies suffix `-rcX` of previous tag)
All keywords MUST be surrounded with square brackets.
+Tag is then stored in `GIT_TAG` variable.
-Alternatively new release can be also created by pushing new tag to master branch.
+##### generate_changelog.sh
-##### Nightly tarball and self-extractor build AND Nightly docker images
+Automatic changelog generator which updates our CHANGELOG.md file based on GitHub features (mostly labels and pull
+requests). Internally it uses
+[github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator) and more
+information can be found on that project site.
+
+##### build.sh and create_artifacts.sh
+
+Scripts used to build new container images and provide release artifacts (tar.gz and makeself archives)
+
+### Nightlies
+
+##### 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:
@@ -70,11 +73,16 @@ cron). Combined they produce:
- tar.gz archive (soon to be removed)
- self-extracting package
-Currently "Nightly tarball and self-extractor build" is using old firehol script and it is planed to be replaced with
-new design.
+This is achieved by running 2 scripts described earlier:
+ - `create_artifacts.sh`
+ - `build.sh`
-##### Nightly changelog generation
+##### Changelog generation
This job is responsible for regenerating changelog every day by executing `generate_changelog.sh` script. This is done
only once a day due to github rate limiter.
+##### Labeler
+
+Once a day we are doing automatic label assignment by executing `labeler.sh`. This script is a temporary workaround until
+we start using GitHub Actions. For more information what it is currently doing go to its code.