diff --git a/docs/patterns/distribute.rst b/docs/patterns/distribute.rst index 872d6e01..8f79a2dd 100644 --- a/docs/patterns/distribute.rst +++ b/docs/patterns/distribute.rst @@ -87,6 +87,25 @@ your packages to be installed as zip files because some tools do not support them and they make debugging a lot harder. +Tagging Builds +-------------- + +It is useful to distinguish between release and development builds. Add a +:file:`setup.cfg` file to configure these options. + + [egg_info] + tag_build = .dev + tag_date = 1 + + [aliases] + release = egg_info -RDb '' + +Running ``python setup.py sdist`` will create a development package +with ".dev" and the current date appended: ``flaskr-1.0.dev20160314.tar.gz``. +Running ``python setup.py release sdist`` will create a release package +with only the version: ``flaskr-1.0.tar.gz``. + + .. _distributing-resources: Distributing Resources diff --git a/docs/patterns/fabric.rst b/docs/patterns/fabric.rst index 4ba667a1..f6ae0330 100644 --- a/docs/patterns/fabric.rst +++ b/docs/patterns/fabric.rst @@ -156,24 +156,6 @@ location where it's expected (eg: :file:`/var/www/yourapplication`). Either way, in our case here we only expect one or two servers and we can upload them ahead of time by hand. -Configuring egg_info --------------------- -If you need to configure your fabric build with tags, you can create a `setup.cfg` -file in the root of your app. An example would be: - - [egg_info] - tag_svn_revision = 1 - tag_build = .dev - tag_date = 1 - - [aliases] - release = egg_info -RDb '' - -And now when running `python setup.py sdist ...` in your fabric file, it will -pick up on these settings and tag appropriately. And when making a release build -it will ignore these build tags as expected. - - First Deployment ----------------