From 38e5125bde4032587c20932ef17c3c4e7d5588d0 Mon Sep 17 00:00:00 2001 From: Torkel Rogstad Date: Mon, 3 Jun 2019 11:18:19 +0200 Subject: [PATCH] Docs: conditional Travis based on commit message --- .travis.yml | 3 +++ docs/contributing-website.md | 6 ++++++ docs/contributing.md | 6 ++++++ 3 files changed, 15 insertions(+) diff --git a/.travis.yml b/.travis.yml index edafef5e99..1b51852265 100644 --- a/.travis.yml +++ b/.travis.yml @@ -48,6 +48,7 @@ before_script: stages: - name: test + if: commit_message !~ /^Docs:/ - name: release if: ((branch = master AND type = push) OR (tag IS present)) AND NOT fork @@ -60,6 +61,8 @@ jobs: include: # run ci-release only if previous stages passed - stage: release + name: Publish library script: sbt ci-release # run website push only if previous stages passed - script: sbt docs/docusaurusPublishGhpages + name: Publish website diff --git a/docs/contributing-website.md b/docs/contributing-website.md index 6b7881b224..7abe6b68e5 100644 --- a/docs/contributing-website.md +++ b/docs/contributing-website.md @@ -83,3 +83,9 @@ files, build the site and push them to GH pages. Before running those commands, you might have to change a few constants in `siteConfig.js`. These are specifed in the comments of that file. + +### CI + +Bitcoin-S uses Travis to run tests and deploy library and website builds. Generally +speaking CI has to pass for a PR to get merged. If you make documentation/website only +changes, you can start your PR title with `Docs:`. This skips running tests on CI. diff --git a/docs/contributing.md b/docs/contributing.md index 9497c1d893..36762fe490 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -159,3 +159,9 @@ The command `sbt testQuick` can also be handy. It runs tests that either: For more information on `testQuick`, see the offical [sbt docs](https://www.scala-sbt.org/1.x/docs/Testing.html#testQuick). + +### CI + +Bitcoin-S uses Travis to run tests and deploy library and website builds. Generally +speaking CI has to pass for a PR to get merged. If you make documentation/website only +changes, you can start your PR title with `Docs:`. This skips running tests on CI.