adf860ea40
- Provides a toplevel documentation structure using Sphinx - Adds a `doc-html` target to the main Makefile - Converts existing documentation to RST format - Add some new documentation / tutorials - Links the developer manual and OCaml documentation - Synchronized documentation on Gitlab pages This patch is co-authored by: - Benjamin Canou <benjamin@canou.fr> - Bruno Bernardo <bernardobruno@gmail.com> - Pietro Abate <pietro.abate@inria.fr>
479 lines
11 KiB
YAML
479 lines
11 KiB
YAML
variables:
|
|
public_docker_image: docker.io/tezos/tezos
|
|
|
|
stages:
|
|
- prepare
|
|
- build
|
|
- test
|
|
- opam
|
|
- publish
|
|
- deploy
|
|
- cleanup
|
|
|
|
## Template for `docker_in_docker` jobs
|
|
|
|
.dind_template: &dind_definition
|
|
image: docker:latest
|
|
variables:
|
|
DOCKER_DRIVER: overlay2
|
|
services:
|
|
- docker:dind
|
|
before_script:
|
|
- docker info
|
|
- docker login -u gitlab-ci-token -p "$CI_BUILD_TOKEN" "${CI_REGISTRY}"
|
|
tags:
|
|
- safe_docker
|
|
|
|
## Prepare docker image with precompiled OCaml/opam
|
|
|
|
prepare:opam:
|
|
<<: *dind_definition
|
|
stage: prepare
|
|
only:
|
|
- schedules
|
|
before_script:
|
|
- . ./scripts/version.sh
|
|
script:
|
|
- ./scripts/create_docker_image.alpine.sh
|
|
- mkdir ~/.docker || true
|
|
- echo "$CI_DOCKER_AUTH" > ~/.docker/config.json ;
|
|
- docker push "tezos/opam:alpine-${alpine_version}_ocaml-${ocaml_version}"
|
|
- docker tag "tezos/opam:alpine-${alpine_version}_ocaml-${ocaml_version}"
|
|
"tezos/opam:latest"
|
|
- docker push "tezos/opam:latest"
|
|
|
|
prepare:opam2:
|
|
<<: *dind_definition
|
|
stage: prepare
|
|
only:
|
|
- schedules
|
|
before_script:
|
|
- . ./scripts/version.sh
|
|
script:
|
|
- ./scripts/create_docker_image.alpine.opam2.sh
|
|
- mkdir ~/.docker || true
|
|
- echo "$CI_DOCKER_AUTH" > ~/.docker/config.json ;
|
|
- docker push "tezos/opam2:alpine-${alpine_version}_ocaml-${ocaml_version}"
|
|
- docker tag "tezos/opam2:alpine-${alpine_version}_ocaml-${ocaml_version}"
|
|
"tezos/opam2:latest"
|
|
- docker push "tezos/opam2:latest"
|
|
|
|
## Tezos
|
|
|
|
build:
|
|
<<: *dind_definition
|
|
stage: build
|
|
script:
|
|
## Building dependencies...
|
|
- ./scripts/create_docker_image.build_deps.sh
|
|
"build_deps" "${CI_BUILD_REF}"
|
|
"${CI_REGISTRY_IMAGE}/build_deps"
|
|
## Preparing sources for the alphanet or the zeronet...
|
|
- if [ "${CI_PROJECT_PATH}" = "tezos/tezos" ] ; then
|
|
./scripts/apply_patch.sh "${CI_BUILD_REF_NAME}" ;
|
|
fi
|
|
## Building...
|
|
- ./scripts/create_docker_image.build.sh
|
|
"${CI_REGISTRY_IMAGE}/build" "${CI_BUILD_REF}"
|
|
"build_deps:${CI_BUILD_REF}"
|
|
## Saving the docker image...
|
|
- docker push "${CI_REGISTRY_IMAGE}/build:${CI_BUILD_REF}"
|
|
|
|
## Basic tests (run on merge requests)
|
|
|
|
.test_template: &test_definition
|
|
stage: test
|
|
image: ${CI_REGISTRY_IMAGE}/build:${CI_BUILD_REF}
|
|
except:
|
|
- master@tezos/tezos
|
|
before_script:
|
|
- cd /home/opam/tezos
|
|
dependencies:
|
|
- build
|
|
|
|
test:ocp-indent:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @runtest_indent
|
|
|
|
test:utils:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @test/utils/runtest
|
|
|
|
test:shell:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @test/shell/runtest
|
|
|
|
test:p2p:io-scheduler:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @test/p2p/runtest_p2p_io_scheduler
|
|
|
|
test:p2p:connection:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @test/p2p/runtest_p2p_connection
|
|
|
|
test:p2p:connection-pool:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @test/p2p/runtest_p2p_connection_pool
|
|
|
|
test:proto_alpha:transaction:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @test/proto_alpha/runtest_transaction
|
|
retry: 1
|
|
|
|
test:proto_alpha:origination:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @test/proto_alpha/runtest_origination
|
|
retry: 1
|
|
|
|
test:proto_alpha:endorsement:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @test/proto_alpha/runtest_endorsement
|
|
retry: 1
|
|
|
|
test:proto_alpha:vote:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @test/proto_alpha/runtest_vote
|
|
retry: 1
|
|
|
|
test:basic.sh:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @test/runtest_basic.sh
|
|
retry: 1
|
|
|
|
test:contracts.sh:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @test/runtest_contracts.sh
|
|
retry: 1
|
|
|
|
test:multinode.sh:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @test/runtest_multinode.sh
|
|
retry: 1
|
|
|
|
test:proto:sandbox:
|
|
<<: *test_definition
|
|
script:
|
|
- jbuilder build @runtest_sandbox
|
|
|
|
## Basic tests through opam packaged (run on master only)
|
|
##
|
|
## We use opam2-beta because we want to run the testsuite,
|
|
## i.e. `opam install --with-test`, and it is buggy in opam.1.2.1. It
|
|
## insists on building the testsuite of all the dependencies... and many
|
|
## package in opam-repository have buggy testsuite packaging.
|
|
|
|
.opam_template: &opam_definition
|
|
image: tezos/opam2
|
|
stage: opam
|
|
only:
|
|
- master@tezos/tezos
|
|
script:
|
|
- ./scripts/opam-pin.sh
|
|
- opam depext --yes ${package}
|
|
- opam install --yes --deps-only ${package}
|
|
- opam install --yes --with-test ${package}
|
|
|
|
opam:01:ocplib-resto:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: ocplib-resto
|
|
|
|
opam:02:ocplib-resto-directory:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: ocplib-resto-directory
|
|
|
|
opam:03:ocplib-resto-cohttp:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: ocplib-resto-cohttp
|
|
|
|
opam:04:ocplib-resto-json:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: ocplib-resto-json
|
|
|
|
opam:05:ocplib-ezresto:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: ocplib-ezresto
|
|
|
|
opam:06:ocplib-ezresto-directory:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: ocplib-ezresto-directory
|
|
|
|
opam:07:tezos-stdlib:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-stdlib
|
|
|
|
opam:08:tezos-data-encoding:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-data-encoding
|
|
|
|
opam:09:tezos-error-monad:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-error-monad
|
|
|
|
opam:10:tezos-stdlib-lwt:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-stdlib-lwt
|
|
|
|
opam:11:tezos-crypto:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-crypto
|
|
|
|
opam:12:tezos-base:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-base
|
|
|
|
opam:13:tezos-node-p2p-base:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-node-p2p-base
|
|
|
|
opam:14:tezos-node-services:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-node-services
|
|
|
|
opam:15:tezos-protocol-environment-sigs:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-protocol-environment-sigs
|
|
|
|
opam:16:irmin-leveldb:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: irmin-leveldb
|
|
|
|
opam:17:tezos-micheline:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-micheline
|
|
|
|
opam:18:tezos-rpc-http:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-rpc-http
|
|
|
|
opam:19:tezos-protocol-compiler:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-protocol-compiler
|
|
|
|
opam:20:tezos-storage:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-storage
|
|
|
|
opam:21:tezos-node-p2p:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-node-p2p
|
|
|
|
opam:22:tezos-node-updater:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-node-updater
|
|
|
|
opam:23:tezos-node-shell:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-node-shell
|
|
|
|
opam:24:tezos-embedded-protocol-alpha:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-embedded-protocol-alpha
|
|
|
|
opam:25:tezos-embedded-protocol-demo:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-embedded-protocol-demo
|
|
|
|
opam:26:tezos-embedded-protocol-genesis:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-embedded-protocol-genesis
|
|
|
|
opam:27:tezos-client-base:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-client-base
|
|
|
|
opam:28:tezos-embedded-client-alpha:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-embedded-client-alpha
|
|
|
|
opam:29:tezos-embedded-client-genesis:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-embedded-client-genesis
|
|
|
|
opam:30:tezos-protocol-demo:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-protocol-demo
|
|
|
|
opam:31:tezos-client:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-client
|
|
|
|
opam:32:tezos-node:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-node
|
|
|
|
opam:33:tezos-protocol-alpha:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-protocol-alpha
|
|
|
|
opam:34:tezos-protocol-genesis:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-protocol-genesis
|
|
|
|
opam:35:tezos-test:
|
|
<<: *opam_definition
|
|
variables:
|
|
package: tezos-test
|
|
|
|
## Publishing (small) docker images with tezos binaries
|
|
|
|
publish:docker:minimal:
|
|
<<: *dind_definition
|
|
stage: publish
|
|
only:
|
|
- master@tezos/tezos
|
|
- alphanet@tezos/tezos
|
|
- zeronet@tezos/tezos
|
|
script:
|
|
- docker pull "${CI_REGISTRY_IMAGE}/build:${CI_BUILD_REF}"
|
|
- if [ "${CI_PROJECT_PATH}" = "tezos/tezos" ] ; then
|
|
./scripts/apply_patch.sh "${CI_BUILD_REF_NAME}" ;
|
|
fi
|
|
- ./scripts/create_docker_image.minimal.sh
|
|
"${public_docker_image}" "${CI_BUILD_REF_NAME}"
|
|
"${CI_REGISTRY_IMAGE}/build:${CI_BUILD_REF}"
|
|
- mkdir ~/.docker || true
|
|
- echo "$CI_DOCKER_AUTH" > ~/.docker/config.json ;
|
|
- docker push "${public_docker_image}:${CI_BUILD_REF_NAME}"
|
|
|
|
## Publish to github...
|
|
|
|
publish:github:
|
|
image: tezos/opam
|
|
stage: publish
|
|
only:
|
|
- master@tezos/tezos
|
|
- alphanet@tezos/tezos
|
|
script:
|
|
- echo "${CI_KH}" > ~/.ssh/known_hosts
|
|
- echo "${CI_PK_GITHUB}" > ~/.ssh/id_rsa
|
|
- chmod 400 ~/.ssh/id_rsa
|
|
- rm -fr .git/refs/original
|
|
- if [ "${CI_PROJECT_PATH}" = "tezos/tezos" ] ; then
|
|
./scripts/apply_patch.sh "${CI_BUILD_REF_NAME}" ;
|
|
fi
|
|
- git push git@github.com:tezos/tezos.git -f HEAD:${CI_BUILD_REF_NAME}
|
|
|
|
|
|
## Relaunching the bootstrap servers of the alphanet.zeronet
|
|
|
|
.bootstrap_template: &bootstrap_definition
|
|
image: tezos/opam
|
|
stage: deploy
|
|
only:
|
|
- alphanet@tezos/tezos
|
|
- zeronet@tezos/tezos
|
|
before_script:
|
|
- echo "${CI_KH}" > ~/.ssh/known_hosts
|
|
- if [ "${CI_BUILD_REF_NAME}" = "alphanet" ]; then
|
|
echo "${CI_PK_ALPHANET}" | tr -d "\r" > ~/.ssh/id_ed25519 ;
|
|
else
|
|
echo "${CI_PK_ZERONET}" | tr -d "\r" > ~/.ssh/id_ed25519 ;
|
|
fi
|
|
- echo "${CI_SSH_CONFIG}" | tr -d "\r" > ~/.ssh/config
|
|
- chmod 600 ~/.ssh/id_ed25519
|
|
allow_failure: true
|
|
|
|
deploy:bootstrap1:
|
|
<<: *bootstrap_definition
|
|
script:
|
|
- ssh bootstrap1
|
|
|
|
deploy:bootstrap2:
|
|
<<: *bootstrap_definition
|
|
script:
|
|
- ssh bootstrap2
|
|
|
|
deploy:bootstrap3:
|
|
<<: *bootstrap_definition
|
|
script:
|
|
- ssh bootstrap3
|
|
|
|
deploy:bootstrap4:
|
|
<<: *bootstrap_definition
|
|
script:
|
|
- ssh bootstrap4
|
|
|
|
deploy:bootstrap5:
|
|
<<: *bootstrap_definition
|
|
script:
|
|
- ssh bootstrap5
|
|
|
|
deploy:bootstrap6:
|
|
<<: *bootstrap_definition
|
|
script:
|
|
- ssh bootstrap6
|
|
|
|
# cleanup:
|
|
# <<: *dind_definition
|
|
# stage: cleanup
|
|
# script:
|
|
# - apk add -U curl jq
|
|
# - ./scripts/delete_ci_image.sh gitlab-ci-token "${CI_BUILD_TOKEN}"
|
|
# "${CI_PROJECT_PATH}/build"
|
|
# "${CI_BUILD_REF}"
|
|
|
|
pages:
|
|
stage: publish
|
|
image: ${CI_REGISTRY_IMAGE}/build:${CI_BUILD_REF}
|
|
only:
|
|
- master@tezos/tezos
|
|
artifacts:
|
|
paths:
|
|
- public
|
|
script:
|
|
- cd /home/opam/tezos
|
|
- sudo apk update && sudo apk upgrade
|
|
- sudo apk add py3-sphinx py3-sphinx_rtd_theme
|
|
- sudo ln -s /usr/bin/sphinx-build-3 /usr/bin/sphinx-build
|
|
- opam install odoc
|
|
- make doc-html && sudo mv docs/_build "${CI_PROJECT_DIR}"/public
|
|
dependencies:
|
|
- build
|