[Notes] [Git][BuildStream/buildstream][tristan/docs-version-badge] 4 com

Tristan Van Berkom pushed to branch tristan/docs-version-badge at BuildStream / buildstream

Commits:

d53c230e

by Tristan Van Berkom at 2018-08-29T10:15:55Z

README.rst: Adding the release and snapshot badges to the readme

This is a part of #528

cfe812d4

by Tristan Van Berkom at 2018-08-29T10:16:09Z

doc: Adding the release badges to the install page and the semantic versioning page

This is a part of #528

bef962fc
by Tristan Van Berkom at 2018-08-29T10:16:15Z
```
Testing
```

93b3a1f0

by Tristan Van Berkom at 2018-08-29T10:19:28Z

README.rst: Adding PyPI badge to the README

This is ported from Chandan's merge request !719

This is a part of #528

Changes:

.gitlab-ci.yml

@@ -50,89 +50,6 @@ source_dist:
  #                    Test stage                     #
  #####################################################
 -# Run premerge commits
 -#
 -.linux-tests-template: &linux-tests
 -  stage: test
 -  variables:
 -    PYTEST_ADDOPTS: "--color=yes"
 -  script:
 -  # Diagnostics
 -  - mount
 -  - df -h
+-
 -  - useradd -Um buildstream
 -  - chown -R buildstream:buildstream .
+-
 -  - export INTEGRATION_CACHE="$(pwd)/cache/integration-cache"
+-
 -  # Unpack and get into dist/buildstream
 -  - cd dist && ./unpack.sh
 -  - chown -R buildstream:buildstream buildstream
 -  - cd buildstream
+-
 -  # Run the tests from the source distribution, We run as a simple
 -  # user to test for permission issues
 -  - su buildstream -c 'python3 setup.py test --index-url invalid://uri --addopts --integration'
+-
 -  # Go back to the toplevel and collect our reports
 -  - cd ../..
 -  - mkdir -p coverage-linux/
 -  - cp dist/buildstream/.coverage.* coverage-linux/coverage."${CI_JOB_NAME}"
 -  artifacts:
 -    paths:
 -    - coverage-linux/
+-
 -tests-debian-9:
 -  image: buildstream/testsuite-debian:9-master-114-4cab18e3
 -  <<: *linux-tests
+-
 -tests-fedora-27:
 -  image: buildstream/testsuite-fedora:27-master-114-4cab18e3
 -  <<: *linux-tests
+-
 -tests-fedora-28:
 -  image: buildstream/testsuite-fedora:28-master-114-4cab18e3
 -  <<: *linux-tests
+-
 -tests-ubuntu-18.04:
 -  image: buildstream/testsuite-ubuntu:18.04-master-114-4cab18e3
 -  <<: *linux-tests
+-
 -tests-unix:
 -  # Use fedora here, to a) run a test on fedora and b) ensure that we
 -  # can get rid of ostree - this is not possible with debian-8
 -  image: buildstream/testsuite-fedora:27-master-114-4cab18e3
 -  stage: test
 -  variables:
 -    BST_FORCE_BACKEND: "unix"
 -    PYTEST_ADDOPTS: "--color=yes"
 -  script:
+-
 -    - export INTEGRATION_CACHE="$(pwd)/cache/integration-cache"
+-
 -    # We remove the Bubblewrap and OSTree packages here so that we catch any
 -    # codepaths that try to use them. Removing OSTree causes fuse-libs to
 -    # disappear unless we mark it as user-installed.
 -    - dnf mark install fuse-libs
 -    - dnf erase -y bubblewrap ostree
+-
 -    # Unpack and get into dist/buildstream
 -    - cd dist && ./unpack.sh && cd buildstream
+-
 -    # Since the unix platform is required to run as root, no user change required
 -    - python3 setup.py test --index-url invalid://uri --addopts --integration
+-
 -    # Go back to the toplevel and collect our reports
 -    - cd ../..
 -    - mkdir -p coverage-unix/
 -    - cp dist/buildstream/.coverage.* coverage-unix/coverage.unix
 -  artifacts:
 -    paths:
 -    - coverage-unix/
 -    - logs-unix/
+-
+-
  # Automatically build documentation for every commit, we want to know
  # if building documentation fails even if we're not deploying it.
  # Note: We still do not enforce a consistent installation of python3-sphinx,
@@ -153,78 +70,10 @@ docs:
      - public/
 -# Check code quality with gitlab's built-in feature.
 -#
 -code_quality:
 -  image: docker:stable
 -  stage: test
 -  variables:
 -    DOCKER_DRIVER: overlay2
 -  allow_failure: true
 -  services:
 -    - docker:stable-dind
 -  script:
 -    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
 -    - docker run
 -        --env SOURCE_CODE="$PWD"
 -        --volume "$PWD":/code
 -        --volume /var/run/docker.sock:/var/run/docker.sock
 -        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
 -  artifacts:
 -    paths: [gl-code-quality-report.json]
+-
  #####################################################
  #                    Post stage                     #
  #####################################################
 -analysis:
 -  stage: post
 -  script:
 -  - |
 -    pip3 install radon
 -    mkdir analysis
+-
 -  - |
 -    echo "Calculating Maintainability Index"
 -    radon mi -s -j buildstream > analysis/mi.json
 -    radon mi -s buildstream
+-
 -  - |
 -    echo "Calculating Cyclomatic Complexity"
 -    radon cc -a -s -j buildstream > analysis/cc.json
 -    radon cc -a -s buildstream
+-
 -  - |
 -    echo "Calculating Raw Metrics"
 -    radon raw -s -j buildstream > analysis/raw.json
 -    radon raw -s buildstream
+-
 -  artifacts:
 -    paths:
 -    - analysis/
+-
 -# Collate coverage reports
 -#
 -coverage:
 -  stage: post
 -  coverage: '/TOTAL +\d+ +\d+ +(\d+\.\d+)%/'
 -  script:
 -    - cd dist && ./unpack.sh && cd buildstream
 -    - pip3 install --no-index .
 -    - mkdir report
 -    - cd report
 -    - cp ../../../coverage-unix/coverage.unix .
 -    - cp ../../../coverage-linux/coverage.* .
 -    - ls coverage.*
 -    - coverage combine --rcfile=../.coveragerc -a coverage.*
 -    - coverage report --rcfile=../.coveragerc -m
 -  dependencies:
 -  - tests-debian-9
 -  - tests-fedora-27
 -  - tests-fedora-28
 -  - tests-unix
 -  - source_dist
+-
  # Deploy, only for merges which land on master branch.
+ #
  pages:
@@ -248,3 +97,4 @@ pages:
    # See https://gitlab.com/gitlab-org/gitlab-ce/issues/35141
+   #
    - master
 +  - tristan/docs-version-badge

README.rst

  About
  -----
++
 +.. image:: https://buildstream.gitlab.io/buildstream/_static/release.svg
 +   :target: https://gitlab.com/BuildStream/buildstream/commits/bst-1.2
++
 +.. image:: https://buildstream.gitlab.io/buildstream/_static/snapshot.svg
 +   :target: https://gitlab.com/BuildStream/buildstream/commits/master
++
 +.. image:: https://img.shields.io/pypi/v/BuildStream.svg
 +   :target: https://pypi.org/project/BuildStream
++
  .. image:: https://gitlab.com/BuildStream/buildstream/badges/master/pipeline.svg
     :target: https://gitlab.com/BuildStream/buildstream/commits/master

doc/source/install_versions.rst

@@ -13,8 +13,12 @@ For example, for a given version number ``X.Y.Z``
   * The ``X.<odd number>.*`` versions are development spanshots intended for testing.
  If you are :ref:`installing from git <install_git_checkout>`, please look for the latest
 -tag in the latest release branch to ensure you're getting the latest release.
 +tag to ensure you're getting the latest release.
 -Current release branches:
 - * `bst-1.2 (latest) <https://gitlab.com/BuildStream/buildstream/commits/bst-1.2>`_
 - * `bst-1.0 (deprecated) <https://gitlab.com/BuildStream/buildstream/commits/bst-1.0>`_
 +* Latest release:
++
 +  .. include:: release-badge.rst
++
 +* Latest development snapshot:
++
 +  .. include:: snapshot-badge.rst

doc/source/main_install.rst

@@ -4,6 +4,11 @@
  Install
  =======
++
 +.. include:: release-badge.rst
++
 +.. include:: snapshot-badge.rst
++
  This section provides instructions for installing BuildStream and its
  companion artifact server on various platforms, along with any installation
  related materials.

doc/source/release-badge.rst

++
 +.. Use this file to include the badge in the documentation, but not in
 +   the README.rst or gitlab rendered materials, that doesnt work.
++
 +   This is partly a workaround for a sphinx issue, we will be able
 +   to avoid the raw html once this is implemented in sphinx:
++
 +       https://github.com/sphinx-doc/sphinx/issues/2240
++
 +   Using the <object> tag instead of the <img> tag which sphinx generates
 +   allows the svg to be "interactive", for us this basically means that
 +   the link we encode in the badge svg is used, rather than static urls
 +   which need to be used around the <img> tag.
++
 +   WARNING: The custom CSS on the style tag will need to change if we
 +            change the theme, so that the <object> tag behaves similar
 +	    to how the <img> tag is themed by the style sheets.
++
 +.. raw:: html
++
 +   <a class="reference external image-reference">
 +     <object style="margin-bottom:24px;vertical-align:middle"
 +             data=""
 +	     type="image/svg+xml"/>
 +     </object>
 +   </a>

doc/source/snapshot-badge.rst

++
 +.. Use this file to include the badge in the documentation, but not in
 +   the README.rst or gitlab rendered materials, that doesnt work.
++
 +   This is partly a workaround for a sphinx issue, we will be able
 +   to avoid the raw html once this is implemented in sphinx:
++
 +       https://github.com/sphinx-doc/sphinx/issues/2240
++
 +   Using the <object> tag instead of the <img> tag which sphinx generates
 +   allows the svg to be "interactive", for us this basically means that
 +   the link we encode in the badge svg is used, rather than static urls
 +   which need to be used around the <img> tag.
++
 +   WARNING: The custom CSS on the style tag will need to change if we
 +            change the theme, so that the <object> tag behaves similar
 +	    to how the <img> tag is themed by the style sheets.
++
 +.. raw:: html
++
 +   <a class="reference external image-reference">
 +     <object style="margin-bottom:24px;vertical-align:middle"
 +             data=""
 +	     type="image/svg+xml"/>
 +     </object>
 +   </a>

[Notes] [Git][BuildStream/buildstream][tristan/docs-version-badge] 4 commits: README.rst: Adding the release and snapshot badges to the readme

Tristan Van Berkom pushed to branch tristan/docs-version-badge at BuildStream / buildstream

Commits:

6 changed files:

Changes: