Tag named "latest" can conflict with RTD "latest"

[metalivedev]

I found that our repo was stuck on an old version because we had a tag named "latest"

[metalivedev]

Suggested fix:

RTD should issue a warning if the user's repo includes a tag named latest as this can apparently conflict with RTD's definition of "latest".

The suggested fix is to remove the tag from the repo and wipe the repo:

# Delete the tag locally
git tag -d latest
# Push the tag change upstream
git push origin :refs/tags/latest

then for the wipe, see the RTD docs

[agjohnson]

Agreed. However if we do accept a latest version, we should probably have a method for reverting the latest version as we originally saw it -- a branch -- to our automatic increment latest version.

[humitos]

I see two different ideas here:

1. suggest the user that latest tag/branch is incompatible with RTD and won't make RTD work properly
2. give the user the ability to choose if he/she wants to use the latest from his/her repository or the auto-created by RTD

Which one is the best one? or both?

[humitos]

From my understanding this is happening because we don't remove the Version instances that are not matching to a branch/tag.

So, if the original branch was called latest we create a Version instance with the attribute machine=False (which means that this is not a version automatically created by RTD). Then, if you remove the branch from the git repository, we don't remove&create that Versions with the machine=True and it gets stuck in an inconsistent state.

There are a similar issue regarding not deleting/syncing the Version properly under #3887 with more information about this.

[humitos]

@stsewd does the fix that we talked the other day will fix this problem also, right? (we do have those 2 special cases to consider in the sync method: stable and latest)

If you haven't done yet, could you add a test case for the latest case also in #3887? Thanks.

[stsewd]

@humitos yeah, I think this is the same bug

[stsewd]

Closing in favor of #3887