The pgRouting community proposes cleanup of pgRouting/Workshop Github repository [1].
We should only have the following branches:
main [2]
develop
gh-pages
Some of the problems are:
Some of the branches are 10 years old such as “FOSS4G2011” branch [3] which is already published at [4].
The FOSS4G Hokkaido workshop is not yet published on the pgRouting Workshop website [5] and the development of the “develop/hokkaido” branch is stalled since 2015 [6].
Many branches start with “develop/” (the “/” normally indicates it belongs to a repository named develop).
This last example is causing some development issues: We are working on having a configured workshop and had to name the working branch as “general-develop” branch due to the lack of “develop” branch and many existing “develop/foo” branches, creating confusion about the correct branch for developing.
Proposal to cleanup of the Workshop repository:
Remember that Github handles tags with semantic versioning, the latest version corresponds to the last pushed tag and any new tags for the stalled branches will not be versioned tags.
The cleanup would comprise of following steps:
Make sure that tags exist for the international FOSS4G workshops
Find the versioned number corresponding to the international branch
If it does not exist, then create a tag with the name: FOSS4G
Delete the branch1. Make sure that tags exist for the local FOSS4G workshops
These are not versioned
Find a corresponding tag for the local branch
If it does not exist, then create a tag with the name:
Delete the branch1. Rename “general-develop” to “develop”
Create branch “develop” based on “general-develop”
Delete branch "general-develop"1. Rename “master” to “main”
Create branch “main” based on “master”
Pending the delete of “master” until things work properly on Github for branch “main”
If this proposal is accepted, I will open an administrative issue on the pgRouting/Workshop Github repository [7], to keep track of all the steps mentioned. The related tags will be placed as Github issues and before removing any branch, a comment will be posted to get thumbs up. A comment will follow post removal of the branch as well.
I agree that cleanup is good and that we should have less branches and more clear conventions.
Sometimes branches may be different to the main workshop, so I’m not sure if a tag would solve the problem.
But whenever a tag (release) solves it, then it’s perfectly fine.
I’m actually not sure if it really makes sense to keep a long list of old workshops.
Who will ever do the old one? Should we really encourage people to look at old ones?
Maybe it would be even better to just have a single workshop.
Regarding branch names, “main” is good and an alternative to “develop” could be “next”.
It is shorter and indicates that it will be the next release. If we already rename things, we could do this as well.
We could also wait with renaming “master” as Github seems to prepare something that will prevent to break stuff: https://github.com/github/renaming
Wishing a very happy new year and apologies for delayed response. Happy 2021 towards a positive new decade!
Thanks for the insightful comments! I will wait to catch-up on pgRouting Gitter for further discussion.
I agree that cleanup is good and that we should have less branches and more clear conventions.
Sometimes branches may be different to the main workshop, so I’m not sure if a tag would solve the problem.
But whenever a tag (release) solves it, then it’s perfectly fine.
I’m actually not sure if it really makes sense to keep a long list of old workshops.
Who will ever do the old one? Should we really encourage people to look at old ones?
Maybe it would be even better to just have a single workshop.
Regarding branch names, “main” is good and an alternative to “develop” could be “next”.
It is shorter and indicates that it will be the next release. If we already rename things, we could do this as well.
We could also wait with renaming “master” as Github seems to prepare something that will prevent to break stuff: https://github.com/github/renaming
The pgRouting community proposes cleanup of pgRouting/Workshop Github repository [1].
We should only have the following branches:
main [2]
develop
gh-pages
Some of the problems are:
Some of the branches are 10 years old such as “FOSS4G2011” branch [3] which is already published at [4].
The FOSS4G Hokkaido workshop is not yet published on the pgRouting Workshop website [5] and the development of the “develop/hokkaido” branch is stalled since 2015 [6].
Many branches start with “develop/” (the “/” normally indicates it belongs to a repository named develop).
This last example is causing some development issues: We are working on having a configured workshop and had to name the working branch as “general-develop” branch due to the lack of “develop” branch and many existing “develop/foo” branches, creating confusion about the correct branch for developing.
Proposal to cleanup of the Workshop repository:
Remember that Github handles tags with semantic versioning, the latest version corresponds to the last pushed tag and any new tags for the stalled branches will not be versioned tags.
The cleanup would comprise of following steps:
Make sure that tags exist for the international FOSS4G workshops
Find the versioned number corresponding to the international branch
If it does not exist, then create a tag with the name: FOSS4G
Delete the branch1. Make sure that tags exist for the local FOSS4G workshops
These are not versioned
Find a corresponding tag for the local branch
If it does not exist, then create a tag with the name:
Delete the branch1. Rename “general-develop” to “develop”
Create branch “develop” based on “general-develop”
Delete branch "general-develop"1. Rename “master” to “main”
Create branch “main” based on “master”
Pending the delete of “master” until things work properly on Github for branch “main”
If this proposal is accepted, I will open an administrative issue on the pgRouting/Workshop Github repository [7], to keep track of all the steps mentioned. The related tags will be placed as Github issues and before removing any branch, a comment will be posted to get thumbs up. A comment will follow post removal of the branch as well.