From 63606a968660a5cfc0450144b0a91125c069ec10 Mon Sep 17 00:00:00 2001
From: Andre Anjos <andre.dos.anjos@gmail.com>
Date: Tue, 22 Jan 2019 08:58:27 +0100
Subject: [PATCH] [doc] Update documentation to enforce release policy and
mention BEAT everywhere
---
doc/index.rst | 8 ++++----
doc/links.rst | 1 +
doc/release.rst | 14 ++++++++++++++
setup.py | 10 +++++-----
4 files changed, 24 insertions(+), 9 deletions(-)
diff --git a/doc/index.rst b/doc/index.rst
index 85f0cded..f26dfe22 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -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
diff --git a/doc/links.rst b/doc/links.rst
index 7b1d52e5..85e0033a 100644
--- a/doc/links.rst
+++ b/doc/links.rst
@@ -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/
diff --git a/doc/release.rst b/doc/release.rst
index 7130bc52..e83da16f 100644
--- a/doc/release.rst
+++ b/doc/release.rst
@@ -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
=========================
diff --git a/setup.py b/setup.py
index 05884050..157d14a5 100644
--- a/setup.py
+++ b/setup.py
@@ -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',
],
)
--
GitLab