openaire / guidelines-cris-managers

OpenAIRE Guidelines for CRIS Managers based on CERIF-XML
https://openaire-guidelines-for-cris-managers.readthedocs.io/
6 stars 16 forks source link

Change the default branch to be `main` (was: `master`) #131

Open jdvorak001 opened 2 years ago

jdvorak001 commented 2 years ago

We should follow the current best practice and change the name of the default branch. The instructions are here.

jdvorak001 commented 2 years ago

Don't forget to reconfigure readthedocs.org and our Github Actions.

ACz-UniBi commented 2 years ago

@jdvorak001 agreed that we rename the branch after the work for v1.1.2 is finalized.

jdvorak001 commented 1 year ago

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.

jdvorak001 commented 1 year ago

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. The main branch stores the official release history, and the develop branch serves as an integration branch for features. It's also convenient to tag all commits in the main 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.

jdvorak001 commented 1 year ago

The main repository adapted

I have now changed the setup of the main repository. So we do not have master any more, just develop (default) and main. I also deleted stale branches.

ReadTheDocs adapted

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).

TODO for developers

Adapt your forks

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):

Adapt your local IDE setup

Once 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: