From 14f705ba208d6713b133ceaff4371356f2a4af88 Mon Sep 17 00:00:00 2001 From: Antonin Bas Date: Thu, 26 Dec 2019 19:20:06 -0800 Subject: [PATCH] Deploy bmv2 doxygen documentation to AWS S3 Every time the master brach is updated, we re-build the doxygen docs in a Travis CI job using a doxygen docker container. The generated files are then uploaded to an AWS bucket. The domain bmv2.org now redirects to that bucket. Fixes #832 --- .travis.yml | 21 +++++++++++++++++++++ Doxymain.md | 2 -- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 5342b3d62..ad802a2a0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,12 +9,33 @@ language: generic services: - docker +stages: + - test + - name: deploy + if: repo = p4lang/behavioral-model AND branch = master + matrix: include: - env: CXX=g++ CC=gcc sswitch_grpc=yes - env: CXX=g++-7 CC=gcc-7 GCOV=gcov-7 sswitch_grpc=no - env: CXX=clang++-3.8 CC=clang-3.8 sswitch_grpc=no - env: CXX=clang++-6.0 CC=clang-6.0 sswitch_grpc=no + - stage: deploy + install: skip + script: docker run --rm -v $(pwd):/data -it hrektts/doxygen doxygen + deploy: + provider: s3 + access_key_id: AKIAIVZMKWSQVOPRXWCQ + secret_access_key: + secure: IBR2S1glm2bahs6/i0ltHfd/S5AOO0/0xmpW+Mk0T7y82xaj1Y45ivBfRDo9o5rSRShYX7mkuVXNckLrY3XOPVacr8Kxbe8Sz3L+Q3J4bYXl0pbwhOGsT/Nd2NUDiUA7eqwTlYH0UpURxCyPbFXl4IFakqTilOywKfi8OepNNTSrALYBg/ahbJqxSArT749/wsY+vVV3zSlBeVk4pWOJVvRF8Qqfmhwkx7jZeemWl6AmTA6Dw8JbBVYLMmgXIkrVhVXOAUb09Ree8eqZWMrvMLmTP2GcdvfoqNDErxD9u/M3reYjpq99wjA/jYuzrbCcgFnNcOa/VPhCehIkb9e3ysrQ5B0zW7+jfqPuEDi/GFycrB9h4uKEcBz5zOZp8Z20BE335lakj2vRbycURvfo8GZFeZ6MLCugZJjgv8aiDwDQ7pNSCmEFQQTwk9aiUVCyM6X7za+BwoQpEkHQb+Xt0mA8cl/m4Xmcx1iRo4PZHoQRnyarajcM4WftSBZt6qGWDgmEsSTEkzfJNlt/1AlNU09Yt2JC/SieIVYREDCYP2d1anR1/G94Ns4LtkDaFqgq3XJjaDWb4BFjJ9EUhInphOt9EbHjBm739x1musVfw2wPy6YgRd3Z9Fwj4mWztSB+NOFBEtE8iixa52Lvr+jGoUz32TlicEdo6eQMEUVPnRA= + bucket: bmv2.org + local-dir: doxygen-out/html + acl: public_read + region: us-west-2 + skip_cleanup: true + on: + repo: p4lang/behavioral-model + branch: master addons: apt: diff --git a/Doxymain.md b/Doxymain.md index 4a8b97ad6..2ea23b542 100644 --- a/Doxymain.md +++ b/Doxymain.md @@ -1,5 +1,3 @@ -# Doxygen ignores the first line - # IMPLEMENTING YOUR SWITCH TARGET WITH BMv2 This guide and the accompanying doxygen documentation are targetted at