readthedocs и setuptools scm version wrong

Question

У меня есть пакет, который я только что обновил, чтобы использовать setuptools_scm и нашел, что номер версии неверен в readthedocs.

http://sshuttle.readthedocs.org/en/v0.77/ показывает:

Version: 0.78.dev0+ng083293e.d20160304 

однако, как версия 083293e имеет 0,77 тег, версия строка должна быть только 0,77

Похоже readthedocs может вносить изменения в мой исходный код, прежде чем строить.

Я просмотрел журналы сборки readthedocs и, кажется, имеет правильную версию на одном этапе (0.77), однако это до того, как она построит документацию.

Processing dependencies for sshuttle==0.77 
Finished processing dependencies for sshuttle==0.77 

В сборках не упоминается версия при сборке документации.

Можно ли это решить?

Благодаря

Answer 1

Документация setuptools_scm теперь instructions о том, как использовать с readthedocs :

Это не рекомендуется использовать setuptools_scm от самого сфинкса, а использовать pkg_resources после редактируемой/реальной установки:

from pkg_resources import get_distribution 
release = get_distribution('myproject').version 
# for example take major/minor 
version = '.'.join(release.split('.')[:2]) 

Основная причина в том, что услуги, такие как readthedocs иногда изменяет WorkingDirectory для хороших причин, и с помощью установленных метаданных предотвращает использование ненужных летучих данных там.

Это позволяет избежать необходимости использования kluges в соответствии с другим ответом.

Answer 2

Я вижу, что вы строите this project.

Очевидно, что что-то мутирует состояние репозитория до того, как будет определена версия. Вы можете повторить подобное поведение мутирует один из файлов перед сборкой Документов себя:

(sshuttle) $ python setup.py --version 
0.77 
(sshuttle) $ cat >> setup.py 
# a comment 
(sshuttle) $ python setup.py --version 
0.78.dev0+ng083293e.d20160403 

В считанных Документах документов, есть description of the process.

Здесь вы можете увидеть шаги, которые выполняет RTD, а именно: (a) запустить setup.py install, затем (b) установить требования в файле требований.txt.

Я подтвердил, что ни один из этих шагов не должен мутировать состояние репо.

Это не объясняет, откуда эта версия, или что делает update_imported_docs. Я подозреваю, что проблема кроется в чем-то тонком, который читает документы, делая это, изменяя репо.

Здесь one place where the conf.py file gets modified.

Возможно, добавление docs/conf.py в ваш .gitignore позволит игнорировать эти изменения и, таким образом, не загрязнять ваше рабочее состояние при расчете версии проекта.

Answer 3

https://github.com/pypa/setuptools_scm/issues/84 был обновлен, чтобы записать этот

мы будем работать с командой сфинкса, чтобы обеспечить автоматизированный/безболезненный вариант этого процесса