Open jdvorak001 opened 2 years ago
Don't forget to reconfigure readthedocs.org and our Github Actions.
@jdvorak001 agreed that we rename the branch after the work for v1.1.2 is finalized.
Now when v1.2.0 has been released, we should get down to this.
As a first step, I am deleting https://readthedocs.org/projects/openaire-guidelines-for-cris-managers-development/, which was used in the finalization of v1.2.0.
Actually, Gitflow looks like a good fit for our needs. Quoting from the document:
Instead of a single
main
branch, this workflow uses two branches to record the history of the project. Themain
branch stores the official release history, and thedevelop
branch serves as an integration branch for features. It's also convenient to tag all commits in themain
branch with a version number.
In this strategy develop
is the default branch, whereas main
tracks just the releases.
On readthedocs, develop
could be presented as development
or draft
, whereas main
is a good basis for both stable
and latest
.
I have now changed the setup of the main repository. So we do not have any more, just master
develop
(default) and main
. I also deleted stale branches.
I also reconfigured readthedocs: I started the develop
version (following the develop
branch, one cannot change the name) and changed latest
to follow main
(only with the default version one can choose a different name).
The easiest way to replicate this new setup in your Github fork of the main repository is to delete it and fork again.
If you don't want to do that, you should do the following (I'm pointing to @ACz-UniBi's fork for the sake of example):
develop
branch:
develop
as the new branch nameopenaire:develop
as the source for the branch: develop
as the default branch
develop
: main
branch, setting it to follow openaire:main
master
branchOnce again, the simplest approach is to delete your local project and clone it again from your updated fork.
If you do not want to do that, you'll need to do the following:
master
branch, both local and remote-trackingdevelop
branch as your new local branchmain
branch as your new local branch
We should follow the current best practice and change the name of the default branch. The instructions are here.