Skip to content
This repository was archived by the owner on Oct 10, 2024. It is now read-only.

Start of versioning page. Covers basics only. #69

Merged
1 commit merged into from
Jul 24, 2018
Merged

Start of versioning page. Covers basics only. #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* [Page Load Speed](page-load-speed.md)
* [Tests](tests.md)
* [Contributing](contribute.md)
* [Versioning](versioning.md)
* [Collaboration](team-collaboration.md)
* [Non-Sprint Work](meetings/non-sprint.md)
* [Dev Portfolio](meetings/dev-portfolio.md)
Expand Down
29 changes: 29 additions & 0 deletions versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Versioning our libraries
========================

Which repositories?
-------------------

Some of our repositories are used as libraries and included as a requirement in other repositories.
eg https://github.com/OpenDataServices/flatten-tool/releases
Copy link
Member

@robredpath robredpath Jul 19, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the /releases page the correct one to link to here?

Copy link
Author

@ghost ghost Jul 24, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, it's just an example link, and given the whole point of this page is released versions then releases seems like a good page to link to.


For these libraries, we want to version them to make it easier to do this.
Copy link
Member

@robredpath robredpath Jul 19, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that docs should state what we do, not what we want to do. So, we should say "For these libraries, we version them to make it easier to do this. This applies to all new libraries. As of July 2018, work to version existing libraries is still in progress".

Copy link
Author

@ghost ghost Jul 24, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we have fully agreed about this - and I note your later comment talks about User needs, which might contradict this. Can we leave this pull request at it is (just saying "some", which is technically true) and have some Loomio discussion to clarify and make more specific points like this later?


Creating versions, and the branching scheme
-------------------------------------------

Versions are created as tags in GitHub, with the format "vX.Y.Z". Semantic versioning should be followed. https://semver.org/

Work is merged to the "master" branch, and versions are tagged directly on the master branch.

This means that when a later version is released, no bug fixes to earlier versions will be released any more.
Copy link
Member

@robredpath robredpath Jul 19, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

(eg "v1.3.6" is followed by "v1.4.0" - this means there will never be a version "v1.3.7".)