okfn-brasil / serenata-toolbox

📦 pip module containing code shared across Serenata de Amor's projects | ** Este repositório não recebe atualizações frequentes **
MIT License
154 stars 69 forks source link

Update package versioning #34

Closed jtemporal closed 7 years ago

jtemporal commented 7 years ago

Serenata Toolbox have 19 merged PR and most of them should generate a new package version if it were a released PYPI package. We should consider update the package version at least when there is new datasets being added or updated.

jtemporal commented 7 years ago

should see Choosing a versioning scheme and PEP440 on final releases. I'm going to map later this week the version based on the changes each merged PR using PEP440 as guide.

jtemporal commented 7 years ago

Following major.minor.micro. The proposed version updates follow this schema:

33 minor: 7.4.1

31 minor: 7.3.1

28 minor: 7.2.1

27 micro: 7.1.1

26 minor: 7.1.0

22 major: 7.0.0

18 major: 6.0.0

17 major: 5.0.0

16 major: 4.0.0

15 major: 3.0.0

14 micro 2.3.1

13 minor: 2.3.0

12 minor: 2.2.0

11 minor: 2.1.0

10 major: 2.0.0

6 major and micro: 1.0.1

4 minor: 0.2.0

3 minor: 0.1.0

1 micro: 0.0.2

With all of the above in mind, the updated package version should be 7.4.1

@cuducos do you have any concerns on the matter that you would like to add?

cuducos commented 7 years ago

Personally I like versioning convetions that focus on the public API, such as Elm's one:

  • PATCH - the API is the same, no risk of breaking code
  • MINOR - values have been added, existing values are unchanged
  • MAJOR - existing values have been changed or removed

(What they call PATCH is what we call micro.)

What do you think about it?

jtemporal commented 7 years ago

@cuducos that seems about right! We can go with that from now on =)