BackTrackZ/scrapy
BackTrackZ/scrapy
1
0
Fork 0
mirror of https://github.com/scrapy/scrapy.git synced 2025-02-23 17:03:40 +00:00
Code Releases Wiki Activity

added clarification about scrapy versioning including the recently adopted odd/even versioning scheme

Browse Source 
--HG--
rename : docs/api-stability.rst => docs/versioning.rst
This commit is contained in:
Pablo Hoffman 2011-07-12 19:53:23 -03:00
parent 4fde1ef94d
commit bfda9ec319
3 changed files with 49 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/api-stability.rst
View File

@ -1,34 +0,0 @@
.. _api-stability:
============================
Versioning and API Stability
============================
API stability is one of Scrapy major goals.
Versioning
==========
When Scrapy reaches 1.0, each release will consist of three version numbers:
* major - big, backwards-incompatible changes
* minor - new features and backwards-compatible changes
* micro - bug fixes only
Until Scrapy reaches 1.0, minor releases (0.7, 0.8, etc) will follow the same
policy as major releases.
Sometimes the micro version can be omitted, for brevity, when it's not
relevant.
API Stability
=============
Methods or functions that start with a single dash (``_``) are private and
should never be relied as stable. Besides those, the plan is to stabilize and
document the entire API, as we approach the 1.0 release.
Also, keep in mind that stable doesn't mean complete: stable APIs could grow
new methods or functionality but the existing methods should keep working the
same way.

4
docs/index.rst
View File

@ -221,13 +221,13 @@ All the rest
:hidden:
contributing
api-stability
versioning
experimental/index
:doc:`contributing`
Learn how to contribute to the Scrapy project.
:doc:`api-stability`
:doc:`versioning`
Understand Scrapy versioning and API stability.
:doc:`experimental/index`

47
docs/versioning.rst Normal file
View File

@ -0,0 +1,47 @@
.. _versioning:
============================
Versioning and API Stability
============================
Versioning
==========
Scrapy uses the `odd-numbered versions for development releases`_.
There are 4 numbers in a Scrapy version: *A.B.C.D*
* *A* is the major version. This will rarely change and will signify very
large changes. So far, only zero is available for *A*
* *B* is the release number. This will include many changes including features
and things that possible break backwards compatibility. Even Bs will be
stable branches, and odd Bs will be development.
* *C* is the bugfix release number, but it has been recently deprecated of
favor of using the revision number (*D*)
* *D* is the revision number of the Mercurial repo from where the release was
taken
For example:
* *0.12.0.2542* is the stable release *12* at revision *2542* (safe to use in
production)
* *0.13.0.2691* is the development release *13* at revision *2691* (use with
care in production)
API Stability
=============
API stability is one of Scrapy major goals for the *1.0* release, which doesn't
have a due date scheduled yet.
Methods or functions that start with a single dash (``_``) are private and
should never be relied as stable. Besides those, the plan is to stabilize and
document the entire API, as we approach the 1.0 release.
Also, keep in mind that stable doesn't mean complete: stable APIs could grow
new methods or functionality but the existing methods should keep working the
same way.
.. _odd-numbered versions for development releases: http://en.wikipedia.org/wiki/Software_versioning#Odd-numbered_versions_for_development_releases