.travis.yml

#############
# Travis CI #
#############
# [PURPOSE] Continuous integration for Ubuntu:
# https://travis-ci.org/

# [REQUIRED] Request to Travis CI staff for using Travis CI for free since 2020:
# https://travis-ci.community/t/
# question-open-source-travis-ci-for-open-source-projects-as-of-august-2022/13233?u=kristinita

# [INFO] You can convert this “.travis.yml” file to “build.sh”
# so that build this site on your machine:
# https://github.com/travis-ci/travis-build

# [NOTE] If Travis CI doesn’t create build for your latest commit,
# your “.travis.yml” file is not valid. Example:
# https://github.com/Kristinita/SashaTravisDebugging/commits/KiraLocalAppVeyor/.travis.yml
#
# [NOTE] “group: travis_latest” doesn't work at April 2018, read end of article:
# https://blog.travis-ci.com/2017-12-01-new-update-schedule-for-linux-build-images
#
# [INFO] Travis CI doesn’t support 32-bit platforms:
# https://stackoverflow.com/a/37087813/5951529

# [INFO] Migration repositories to travis-ci.com:
# https://docs.travis-ci.com/user/migrate/open-source-repository-migration

# [LEARN][TRAVIS] Sections:
# https://docs.travis-ci.com/user/job-lifecycle
# https://stackoverflow.com/a/34384262/5951529
#
# [LEARN][TRAVIS] Exit codes:
# https://docs.travis-ci.com/user/job-lifecycle#breaking-the-build


# [DECLINED] “sudo” key no effect anymore:
# https://app.travis-ci.com/github/Kristinita/SashaTravis/jobs/581136557
# /config#rccb_SashaTravis:.travis.yml@604d44b6314c9791.8
# https://blog.travis-ci.com/2018-11-19-required-linux-infrastructure-migration
#
# [NOTE] Needs for correct APT addon usage:
# https://docs.travis-ci.com/user/reference/overview/
#
# [COMPARE]:
# https://travis-ci.org/Kristinita/SashaScrutinizer/builds/370138075
# https://travis-ci.org/Kristinita/SashaScrutinizer/builds/370122401
# sudo: enabled


# [LEARN][TRAVIS] OS:
# https://docs.travis-ci.com/user/reference/overview/
os: linux


# [LEARN][TRAVIS] Compare Travis Ubuntu environments;
# “focal” is the latest for September 2020:
# https://docs.travis-ci.com/user/reference/linux#overview
dist: focal


# [FIXME] DotNet doesn’t work correctly with AWS Graviton2:
# https://app.travis-ci.com/github/Kristinita/KristinitaPelican/jobs/525301413#L284-L286
#
# [LEARN][TRAVIS] Faster AWS Graviton2 processor:
# https://blog.travis-ci.com/2020-09-11-arm-on-aws
# arch: arm64-graviton2
#
# [REQUIRED] https://blog.travis-ci.com/2020-09-11-arm-on-aws#how-to-get-started
# group: edge

# [LEARN][TRAVIS] Faster LXD container:
# https://blog.travis-ci.com/2020-09-11-arm-on-aws#lxd-and-vm-virtualizations
# virt: lxd


# [INFO] Don't download all repository history, that save a time:
# https://docs.travis-ci.com/user/customizing-the-build/#git-clone-depth
git:
  depth: 1


# [LEARN][TRAVIS] Environment
#
# [LEARN][TRAVIS] Using secure variables for Travis CI:
# https://docs.travis-ci.com/user/environment-variables/#defining-encrypted-variables-in-travisyml
#
# [LEARN][TRAVIS] Encrypt variables locally:
# https://docs.travis-ci.com/user/environment-variables/#encrypting-environment-variables
#
# [NOTE] Variables must be secured!
# If you push to GitHub unsecured token, GitHub remove it, and you will need create new;
# you will get message as this:
# https://github.com/nodejs/build/issues/1353#issuecomment-397950573
env:
  global:
  # [LEARN][TRAVIS] Needs get GitHub token with “public_repo” scope:
  # https://docs.travis-ci.com/user/deployment/pages/#setting-the-github-token
  #
  # [LEARN][YAML] YAML multiline strings:
  # https://stackoverflow.com/a/21699210/5951529
  # https://yaml-multiline.info/
  #
  # [NOTREQUIRED] Quotes around variables

  # [INFO] Equivalent: TOKEN_GITHUB_FOR_TRAVIS_DEPLOY = my real token
  - secure: >
      L2my4oDf6RtE36cchK+NOYQYovfbsDYGGKzjwnUVOYflbZMA8++p3m7jrK/43RtOZ6l0z7ITX80yc/
      TqZk4owULulRcmU3iQsWbRYQlFUJmKZ0rKYLMz3FAK5bWBPO/ZcKC8N0egAb7+
      OFFQV0At6nyuIpwlVMKuFMqyfYxDeHZUMRzOxj8/El1xSKf71wtC3Ms+
      NGZojUN4ixpt5EU0e8x8INUMk4zhVpCwT2GyERpIaPA0Tdocqbbcu2JAua4+JhWXfgq/
      W3q1F3DJgBxFawaYarlMlOOrIv8Ax4JZGTUFMaLzVRS+g2IzNNVID3fT5PTJ5Ifn8PZxuyV2WgF8+
      iHMORFINOCdRcrA8SfyTXpcq0aJ4/I+q9oK35lwdL8fwXLb4sjQ8L/2siKPQoa58QjsWYlUrUE/EhVi+
      Ujmi4taIjXBCLk1VZfSN1tbxIHESCzzBgvHDlrWqp3CoZHUMZx6Ay3VCOBtORcYQpSajnK9oWGhzVpphdV0gU1Ubncrt8iTSiCqMDjCCk7I1YfY+
      S0ICg0ld84hiLP5AsSXobipyinQvxMhlBPf2yxchVTMbASo8L0mT8Q9WHNCB//
      DcrRLq+KR6C4O3JG18KJnX+6TkbP+
      1wmWiKrjRmRoN68YwQAyzmXcgvRXXcxKoSch8DbVIEW2AAd388Tfw5dibHk=

  # [INFO] Equivalent: API_KEY_APPVEYOR = my real key:
  # https://kristinita.netlify.app/Pages/About-for-developers#AppVeyor
  - secure: >
      qE2c+aZb9QGtPF9VG6WhAP2iT0mTDAnmueEiqWUctgalhAFAJ4wdSqvHNNv+F2178wE92WcpT3/
      chmJltlBj1Qqx6vWevJR2ff1uNbQnwGHYBw+1c8JOvx7mUvisp/nzU1eIpU50/
      uDMF6PnUQ7j269nE1seEjUo7aP98rVHDXZ1uYaOVIEKq40HhLMOlfQg4mhpN1zxQLL7eCy7YgQWXDUb4yRT6TU1BxI3uIC9y8LVgv0le3L8hikD2yR
      ++wJwFHSu9nTm9/
      liSxCb4TINZ/mILZ7nzC4UWfNqwRgzz+5n4klcHxeuDORRh9dFQnN3EGsdrScf0Re1oDdUezdYkvgCRzWIgYYPn0FNnmuZl3ccg6JDhRyV+
      LzTv+XiosDojqdHr7R10ae/
      2gyExR+uARIvf0dFnTIBztVnKRtzuPYdsPOkU7R6rM8FnMAjK4G5yjJO4QcZqMo+BzY8O2gqWFba6nxhDk1OBWj/14+jU2pfkW8cR4vq3Us/
      upPuNJhHdtv+S5vuuF9/
      CksWBqUi3QMQYkSMT5Xkv5YcTeWqQe6W4U2hVg7+Tl1jesn2WP6nM6j
      +I2W5fJwYWIKB7U0hP6WR0jkrHDvMNfWgaB8VZCxYoVUFvCMf5IBnXgRGkYjJn9KkQv3pfODC5aUdep2mCWL+cYiHBukRncS66bs/
      EAE=

  # [INFO] Equivalent: API_KEY_PAGESPEED_INSIGHTS_V5 = my real key
  - secure: >
      u4bZ1LyhoUDKvng6cwQRlrKzR0EgFpnHSk0+zVH8entxT2tP8Ltir7IDrhY+v2+a7EXn3c/
      61ukV3QpF3qCBA9zBk7awfG4cW6DIVE1ZyQPFcVeT/LGqD5kAzHOM3m06k2HD0LS97FxQF9b5de1Edx6vAwtdLBILneXtGpMwENCKYT/
      FHkMLdRywIUSPAoQSuJRxX1OTxN7n5DA4nQ6YqOi4kZs2sWfFe3nGlIYjHtbJEnh11OBuwY5j2V8AoT/
      DBpsXOJAtXI+aQ0rRYIdZvcchHjiV8bp3jNgbpWAeWKqwfgU8fCMx16poizGzqzlw4n4uCFuc7Rv5TSbkwDYy5eR/
      vlBe+5XnbGCQcyefkpQabSYOXCNVeABGUc32snN8XdSq69m+lyO5+uSi7/
      gLHg+7yEcR8nA3g+ZC2cFWLA92HTqM7tMhAbNjQ+V9rqJLqAHYQtaItFiCXveoe6p3f628RU/
      lmIISg0P2VtPLZIw4sCSJ9ts3dnOtADkYDiruXF1laoKmw4+73TpbNsvxNTYitSnWFsAOKoZqzCX3+t5v+swkb7gc7i+pXKDwuLaF6pF1lemV/
      3bpq7yay5d6KmMIPpDwW+rBNLhCbzxPLpGdG40xd9Gs+w6iRoRXIlChh6PuGohDAPcA/oMofXtHic3hx5ViAPDcxsoB5pjc8CM=


# [LEARN][TRAVIS] Needs “language: bash” for multilanguage projects:
# https://github.com/travis-ci/travis-ci/issues/4895
# https://github.com/travis-ci/docs-travis-ci-com/issues/910
#
# [NOTE] But so that use latest Python 3 version, not Python 2, you need “language: python” or
# install Python via APT addon:
# https://stackoverflow.com/a/37660551/5951529
# https://travis-ci.org/Kristinita/SashaScrutinizer/builds/370118828
# https://github.com/travis-ci/travis-ci/issues/9180
language: python


# [INFO] I use the latest available Python version:
# https://docs.travis-ci.com/user/languages/python/#python-versions
python: 3.10


# [LEARN][TRAVIS] APT addon:
# https://docs.travis-ci.com/user/installing-dependencies/#Installing-Packages-with-the-APT-Addon
#
# [LEARN][TRAVIS] APT sources whitelist:
# https://github.com/travis-ci/apt-source-whitelist
#
# [LEARN][TRAVIS] APT package whitelist:
# https://github.com/travis-ci/apt-package-whitelist
addons:
  apt:
    packages:
    # [INFO] For .NET Core SDK installation:
    # https://dotnet.microsoft.com/download/linux-package-manager/ubuntu16-04/sdk-current
    - apt-transport-https

    # [INFO] Parallel installation:
    # https://unix.stackexchange.com/a/427419/237999
    - parallel

    # [DEPRECATED] In August 2022 Tidy installation via Snap or Apt available
    #
    # [INFO] For HTML Tidy building:
    # https://askubuntu.com/a/1027128/582218
    # - xsltproc


# [NOTE] Cache not needed for this project.
#
# [LEARN][TRAVIS] Cache needs, when 1 job install dependencies, another jobs runs test, using the cache:
# https://docs.travis-ci.com/user/build-stages/warm-cache/
#
# [INFO] Cache upload after “script” phase:
# https://docs.travis-ci.com/user/caching/#Build-phases
#
# [NOTE] Cache doesn’t save between “images” — new builds: new virtual machine for each build:
# https://docs.travis-ci.com/user/caching/#Things-not-to-cache


before_install:
# [LEARN][PIPENV] Virtual environment inside project directory:
# https://jcutrer.com/howto/dev/python/pipenv-pipfile
# https://pipenv.pypa.io/en/latest/advanced/#pipenv.environments.PIPENV_VENV_IN_PROJECT
# “setx PIPENV_VENV_IN_PROJECT 1” for Windows
- export PIPENV_VENV_IN_PROJECT=1

# [LEARN][PIPENV] Ignore existing virtual environments:
# https://github.com/menzenski/pipenv-travis-test/blob/develop/.travis.yml
# https://pipenv.pypa.io/en/latest/advanced/#pipenv.environments.PIPENV_IGNORE_VIRTUALENVS
- export PIPENV_IGNORE_VIRTUALENVS=1

# [FIXME] Traceback if skip-lock:
# https://github.com/pypa/pipenv/issues/4141
# https://travis-ci.com/github/Kristinita/KristinitaPelican/jobs/440616814#L272-L305
# https://ci.appveyor.com/project/Kristinita/kristinitapelican/builds/36332074/job/p7amggsx8flrw7p7#L168
#
# [INFO] Disable lock feature in the Pipenv:
# https://pipenv.pypa.io/en/latest/cli/#envvar-PIPENV_SKIP_LOCK
# https://github.com/pypa/pipenv/issues/2200
#
# 1. It the extra feature
# 2. And too slow
- export PIPENV_SKIP_LOCK=1

# [INFO] Remove .NET Core SDK telemetry:
# https://docs.microsoft.com/en-us/dotnet/core/tools/telemetry#disclosure
# https://stackoverflow.com/a/39307563/5951529
- export DOTNET_CLI_TELEMETRY_OPTOUT=1

# [INFO] Don’t install pylint from grunt-pylint
# https://www.npmjs.com/package/grunt-pylint#getting-started
- export GRUNT_PYLINT_SKIP_POSTINSTALL=yes

# [NOTE] Disable Node.js warnings:
# https://nodejs.org/api/cli.html#cli_node_no_warnings_1
# It a not the best solution, a lot of warnings from old Grunt packages
# prevent normal viewing of output, example:
# https://ci.appveyor.com/project/Kristinita/kristinitapelican/build/job/qhr57grom9dohssp
- export NODE_NO_WARNINGS=1

# [LEARN][UNIX] Add LocalAppVeyor directory to the end of the PATH environment variable:
# https://unix.stackexchange.com/a/26067/237999
# http://www.troubleshooters.com/linux/prepostpath.htm
#
# [INFO] “.dotnet/tools” must be added to PATH:
# https://github.com/dotnet/cli/issues/9208#issuecomment-386851831
#
# [INFO] DotNet user profile is “USERPROFILE” on Windows and “HOME” on Linux:
# https://github.com/dotnet/cli/issues/7569#issuecomment-329280924
#
# [INFO] “$HOME” is “/home/travis” on Travis Linux:
# https://docs.travis-ci.com/user/environment-variables/#default-environment-variables
- export PATH=$PATH:$HOME/.dotnet/tools

# [NOTE] That script run for “master” branch, not for “HEAD”;
# Needs, that “grunt-checkbranch” works correct:
# https://stackoverflow.com/a/18866140/5951529
- git checkout master

# [NOTE] For correct displaying Non-ASCII symbols in Travis CI console:
# https://stackoverflow.com/a/34549249/5951529
- git config --global core.quotePath false


install:
# [INFO] ShellCheck default in Travis CI configuration:
# https://github.com/koalaman/shellcheck#travis-ci
#
# [INFO] PhantomJS is preinstalled on Travis:
# https://docs.travis-ci.com/user/gui-and-headless-browsers/#using-phantomjs

# [NOTE] Node.js latest version required;
# because by default this build will not work correctly:
# https://travis-ci.org/github/Kristinita/KristinitaPelican/jobs/728121010
#
# [LEARN][NVM] Install the latest Node.js version by NVM:
# https://github.com/nvm-sh/nvm#usage
# https://travis-ci.org/github/Kristinita/SashaTravisDebugging/builds/728253580#L187-L188
#
# [INFO] David Welsh reccomends NVM installation:
# https://davidwalsh.name/nvm

# [NOTE] “nvm install node” must be in “.travis.yml” file, not in external files;
# otherwise you get error “nvm: command not found”:
# https://travis-ci.org/github/Kristinita/SashaTravisDebugging/builds/728278371#L182
# https://travis-ci.org/github/Kristinita/KristinitaPelican/jobs/728274971#L238
# https://github.com/travis-ci/travis-ci/issues/6027
# https://github.com/travis-ci/travis-ci/issues/5999

# [NOTE] Doesn’t work:
# 1. “node_js: node”:
# https://docs.travis-ci.com/user/languages/javascript-with-nodejs/#specifying-nodejs-versions
# https://travis-ci.org/github/Kristinita/SashaTravisDebugging/builds/728248259#L182-L183
# Node.js from apt addon:
# https://travis-ci.org/github/Kristinita/SashaTravisDebugging/builds/728250645#L223-L224
#
# 2. “.nvmrc”:
# https://docs.travis-ci.com/user/languages/javascript-with-nodejs/#specifying-nodejs-versions-using-nvmrc
# https://travis-ci.org/github/Kristinita/SashaTravisDebugging/builds/728252349#L182-L183
#
# 3. “apt-get -y install node.js”:
# https://stackoverflow.com/a/21119945/5951529
# https://travis-ci.org/github/Kristinita/SashaTravisDebugging/builds/728252818#L219-220
- nvm install node

# [NOTE][COMPARE] Parallelshell works, but no time economy:
# https://travis-ci.org/Kristinita/SashaPelicanTest/jobs/347254717
# https://travis-ci.org/Kristinita/SashaPelicanTest/jobs/347267767
- bash bash/travis-install.sh


# [DECLINED] I don’t need multi-jobs for my configuration,
# so I disabled the “jobs” key.
###
# [LEARN][TRAVIS] “matrix.include”:
# https://docs.travis-ci.com/user/customizing-the-build#build-matrix
#
# [INFO] “matrix” key is alias for “jobs”:
# https://github.com/travis-ci/docs-travis-ci-com/issues/1500#issuecomment-444095922
#
# [FIXME] commitlint-travis bug
# https://app.travis-ci.com/github/Kristinita/KristinitaPelican/jobs/525293245#L2243-L2266
# I disable commitlint-travis (that is “grunt travis”)
#
# [FIXME] Disable clean-console for Travis CI. Travis unable to load some images:
# https://app.travis-ci.com/github/Kristinita/KristinitaPelican/jobs/560440148#L2849-L2964
# jobs:
#   include:
#   - script:
#     - grunt
#     - grunt http-server checkPages && grunt validate notappveyor
#   - script:
#     - grunt
#     - grunt validate notappveyor
#     # [INFO] Deploy, if production, not dev build:
#     # https://travis-ci.org/Kristinita/SashaTravis/builds/381271402
#     #
#     # [INFO] I make as cotila user:
#     # https://github.com/calebzulawski/cotila/blob/master/.travis.yml
#     - MATRIX_DEPLOY=1


script:
- grunt
- grunt http-server checkPages
- grunt validate notappveyor


after_success:
- grunt aftertests


# [LEARN][TRAVIS] Automatically deploy site to GitHub Pages:
# https://docs.travis-ci.com/user/deployment
# https://docs.travis-ci.com/user/deployment/pages/
#
# [INFO] Changes not deploy, if pull request:
# https://docs.travis-ci.com/user/deployment#Pull-Requests
#
# [WARNING] If “script” failed, deploying doesn’t run;
# else “pelican_scaffold”, deploy run, even if “script” failed;
# don’t use “pelican_scaffold” for deployment:
# https://github.com/textbook/pelican_scaffold
deploy:

  # [LEARN][TRAVIS] Deploy strategies:
  # https://docs.travis-ci.com/user/deployment-v2/providers/pages/#shared-options
  strategy: git
  provider: pages

  # [LEARN][TRAVIS] dpl v2:
  # https://blog.travis-ci.com/2019-08-27-deployment-tooling-dpl-v2-preview-release
  # https://docs.travis-ci.com/user/deployment-v2/providers/pages
  edge: true
  on:
    branch: master

    # [DECLINED] I disable multi-jobs
    ###
    # [INFO] Deploy site, if “grunt publish”, else “grunt” — not deploy:
    # https://docs.travis-ci.com/user/deployment#Conditional-Releases-with-on%3A
    # condition: $MATRIX_DEPLOY

  # [INFO] Git history keeping by default in dpl v2:
  #
  # [LEARN][TRAVIS] Don’t overwrite commit history of destination repository:
  # https://docs.travis-ci.com/user/deployment/pages/
  # keep-history: true

  # [INFO] Cleanup deprecated in dpl v2, “cleanup” is “false” by default
  #
  # [LEARN][TRAVIS] Don’t clean output folder:
  # https://docs.travis-ci.com/user/deployment/pages/
  # skip-cleanup: true

  target_branch: master
  local_dir: output
  repo: Kristinita/Kristinita.github.io

  # [LEARN][TRAVIS] “TOKEN_GITHUB_FOR_TRAVIS_DEPLOY” is secure variable, that set in repository settings:
  # https://docs.travis-ci.com/user/environment-variables#Defining-Variables-in-Repository-Settings
  # https://docs.travis-ci.com/user/deployment/pages/#Setting-the-GitHub-token
  #
  # [WARNING] You need set secure variables for each repository,
  # variables for all repositories not possible at the time:
  # https://github.com/travis-ci/travis-ci/issues/2069

  # [INFO] “deploy_key” is another option instead of “token”:
  # https://docs.travis-ci.com/user/deployment-v2/providers/pages/#known-options
  # https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys
  #
  # [INFO] “token” is alias for “github_token”:
  # https://docs.travis-ci.com/user/deployment-v2/providers/pages/#known-options
  token: $TOKEN_GITHUB_FOR_TRAVIS_DEPLOY

  # [LEARN][TRAVIS] Use name and e-mail of committer:
  # https://docs.travis-ci.com/user/deployment/pages/#Further-configuration
  #
  # [INFO] For dpl v.2 “committer_from_gh”, not “committer-from-gh”:
  # https://docs.travis-ci.com/user/deployment-v2/providers/pages/#known-options
  committer_from_gh: true

  # [INFO] I re-enable it, if I get custom domain again
  #
  # [INFO] Automatically generate CNAME for custom domains:
  # fqdn: kristinita.netlify.app

  # [NOTE] Don’t use single quotes in “project_name”:
  # https://github.com/travis-ci/travis-ci/issues/9325
  #
  # [INFO] “project_name”, not “project-name” for dpl v.2
  project_name: Поиск Кристиниты
  verbose: true

  # [INFO] Custom deploy message
  #
  # [INFO] Multiline message:
  # https://github.com/travis-ci/dpl/issues/1126
  #
  # [INFO] Available variables:
  # 1. Travis Environment Variables:
  # https://docs.travis-ci.com/user/environment-variables/#default-environment-variables
  #
  # 2. Known options:
  # https://docs.travis-ci.com/user/deployment-v2/providers/pages/#known-options
  #
  # [INFO] For deploy message I use plain YAML with leading spaces:
  # https://github.com/Kristinita/SashaTravis.github.io/commit/18f1790be2eb90d5949a6a9b990becd3a42d1b6d
  # https://stackoverflow.com/a/21699210/5951529
  # https://yaml-multiline.info/
  commit_message: Commit https://github.com/$TRAVIS_REPO_SLUG/commit/$TRAVIS_COMMIT successfully
     builded and checked by Travis CI build $TRAVIS_BUILD_NUMBER.
     See https://travis-ci.com/$TRAVIS_REPO_SLUG/builds/$TRAVIS_BUILD_ID for details.


# [INFO] Run command after site deployment.
#
# [NOTE] “exit_codes” doesn’t work for “after_deploy” by default:
# https://docs.travis-ci.com/user/job-lifecycle#breaking-the-build
# https://github.com/travis-ci/travis-ci/issues/1574
#
# [INFO] Use “travis_terminate” for it:
# https://github.com/travis-ci/travis-ci/issues/1574#issuecomment-451787844
# https://travis-ci.org/Kristinita/SashaTravis/builds/502952826
# https://travis-ci.org/Kristinita/SashaTravis/builds/502951558
# https://github.com/travis-ci/docs-travis-ci-com/issues/1899
# http://bit.ly/2UkR2y9
after_deploy: >
  if ! grunt afterdeploy
    then travis_terminate 1
  fi