Skip to content
Snippets Groups Projects
Commit 63606a96 authored by André Anjos's avatar André Anjos :speech_balloon:
Browse files

[doc] Update documentation to enforce release policy and mention BEAT everywhere

parent baaada86
No related branches found
Tags v5.0.0
No related merge requests found
Pipeline #26218 passed
......@@ -2,11 +2,11 @@
.. _bob.devtools:
=======================
Bob Development Tools
=======================
============================
Bob/BEAT Development Tools
============================
This package provides tools to help maintain Bob_.
This package provides tools to help maintain Bob_ and BEAT_.
Documentation
......
......@@ -4,6 +4,7 @@
.. _conda: https://conda.io
.. _bob: https://www.idiap.ch/software/bob
.. _beat: https://www.idiap.ch/software/beat
.. _shell executor: https://docs.gitlab.com/runner/executors/shell.html
.. _gitlab runner: https://docs.gitlab.com/runner/install/osx.html
.. _docker for mac: https://docs.docker.com/docker-for-mac/install/
......@@ -24,6 +24,20 @@ Using these scripts is a 2-step process:
Use the ``--help`` flag in each command to learn more about each command.
.. warning::
While *beta* builds of packages will use the beta version of this package,
*stable* will look for the **latest stable** version of this package for
their build configuration.
To **correctly** produce a release, ensure a **STABLE** version of
bob.devtools is properly released **before** you start tagging packages.
The builds will then use such version of this package to enforce the correct
build environment during the packaging.
If you forget to properly tag this package before doing so you risk building
against the wrong set of dependencies.
Manually update changelog
=========================
......
......@@ -23,11 +23,11 @@ requires = [
setup(
name="bob.devtools",
version=version,
description="Tools for development and CI integration of Bob packages",
description="Tools for development and CI integration of Bob/BEAT packages",
url='http://gitlab.idiap.ch/bob/bob.devtools',
license="BSD",
author='Bob Developers',
author_email='bob-devel@googlegroups.com',
author='Bob/BEAT Developers',
author_email='bob-devel@googlegroups.com,beat-devel@googlegroups.com',
long_description=open('README.rst').read(),
packages=find_packages(),
......@@ -64,12 +64,12 @@ setup(
},
classifiers=[
'Framework :: Bob',
'Development Status :: 3 - Alpha',
'Development Status :: 4 - Beta',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Natural Language :: English',
'Programming Language :: Python',
'Programming Language :: Python :: 3',
'Topic :: Software Development :: Libraries :: Python Modules',
'Topic :: Software Development :: Build Tools',
],
)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment