diff options
Diffstat (limited to '.travis/README.md')
| -rw-r--r-- | .travis/README.md | 21 |
1 files changed, 8 insertions, 13 deletions
diff --git a/.travis/README.md b/.travis/README.md index 57efa9a122..c737b5aba0 100644 --- a/.travis/README.md +++ b/.travis/README.md @@ -2,7 +2,7 @@ ## Variables needed by travis -- GH_TOKEN - GitHub token with push access to repository +- GITHUB_TOKEN - GitHub token with push access to repository - DOCKER_USERNAME - Username (netdatabot) with write access to docker hub repository - DOCKER_PASSWORD - Password to docker hub - encrypted_decb6f6387c4_key - Something to do with package releasing (soon to be deprecated) @@ -12,18 +12,6 @@ ## Stages -### Lint - -Stage is executed every time and consists of 4 parallel jobs which check for any deviation from coding conventions. -Checks are performed using: - - csslint (CSS) - - eslint (JS) - - shellcheck (shell scripts) - - flake8 (python) - -Ideally any error should cause whole CI pipeline to fail. Unfortunatelly right now only shellcheck and eslint are -causing pipeline to fail. - ### Test Unit tests and coverage tests are executed here. Stage consists of 2 parallel jobs: @@ -46,6 +34,13 @@ This stage is executed only on "master" brach and allows us to create a new tag 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. + ### Packages As a name might suggest, this stage is responsible for creating netdata packages such as: |