-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CHANGELOG.md vs PyPI? #2828
Comments
Yeah that's weird. Both are missing. The step is manual though, not automated, so maybe @mpenkov skipped it / forgot. |
I guess reason was in release from separate branch (not |
Interesting. But that's pretty weird too – what else (other changes) are missing from |
From #2820: Diff with current develop HEAD The only thing that's missing is last-minute changes to get Py2.7 working on 3.8.3. We deliberately chose not to merge them into develop, because then we'd have more work to do when removing Py2.7 for real in the very immediate future. |
They are part of our checklist here. |
That's the same link as above :)
That link attempts to open a new PR. Here are the files that changed; there's more than just CHANGELOG: $ git diff --name-only develop release-3.8.3
.gitattributes
.travis.yml
CHANGELOG.md
appveyor.yml
azure-pipelines.yml
continuous_integration/appveyor/install.ps1
continuous_integration/appveyor/requirements.txt
continuous_integration/appveyor/run_with_env.cmd
docs/src/conf.py
gensim/__init__.py
gensim/corpora/dictionary.py
gensim/corpora/sharded_corpus.py
gensim/models/doc2vec.py
gensim/models/fasttext.py
gensim/models/hdpmodel.py
gensim/similarities/nmslib.py
gensim/test/test_corpora_dictionary.py
gensim/test/test_fasttext.py
gensim/test/test_utils_any2vec.py
setup.py
tox.ini EDIT: Looks mostly safe but we have to be careful not to leave behind relevant changes. |
What action do we need to take? I can think of several options:
I'm OK with 1), but it does not address the original issue raised by @gojomo. I'm also OK with 2), but it's a bit of a half-measure. I don't like 3) because it's silly. |
Option 1 (incomplete CHANGELOG) is not an option. Ideally we'd have two branches that differ only in the py2 changes, so we can go back and forth easily in the future. Option 3 is the closest and cleanest. So that leaves option 2. Only I'm not 100% sure CHANGELOG is the only difference. For example, how about the changes to |
I'd recommend against doing that - we'd have to deal with the ongoing pain of maintaining Py2.7. The changes to tox.ini were to make Py27 happy. One line enables Py27 builds, another one disables an optional pytest extension that refused to work with Py27. The same thing goes for test_utils_any2vec.py. Py3 accepts 'bw' as a mode, Py2.7 does not. If you're happy with the above explanation, let me know, and I will copy the changelog across. |
Sure – as long as all relevant changes are in |
PyPI shows gensim releases "3.8.2" and "3.8.3". But these aren't mentioned in the
CHANGELOG.md
, nor were they announced on the project discussion list. (There was a tweet announcing 3.8.3.) Should those steps – especially, updatingCHANGELOG.md
– be part of a release checklist, or maybe even some sort of automated-pre-release check?The text was updated successfully, but these errors were encountered: