Skip to content
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

Write the 1.7 release notes #3846

Merged
merged 1 commit into from
Jul 18, 2019
Merged

Conversation

Gallaecio
Copy link
Member

@Gallaecio Gallaecio commented Jun 27, 2019

Current coverage: 44eb21a

Includes a note about dropping Python 2 support in Scrapy 2.0.

Fixes #3872.

@codecov
Copy link

codecov bot commented Jun 27, 2019

Codecov Report

Merging #3846 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #3846   +/-   ##
=======================================
  Coverage   85.56%   85.56%           
=======================================
  Files         164      164           
  Lines        9565     9565           
  Branches     1435     1435           
=======================================
  Hits         8184     8184           
  Misses       1133     1133           
  Partials      248      248

@kmike
Copy link
Member

kmike commented Jun 28, 2019

hey @Gallaecio! I also tried to put all pull requests for new changes in thee 1.7 milestone a few days ago (https://github.com/scrapy/scrapy/milestone/22), maybe this would help you. Not 100% sure all PRs are there though, I could have missed something, or added something which shouldn't be there.

@kmike kmike added this to the v1.7 milestone Jun 28, 2019
docs/news.rst Outdated Show resolved Hide resolved
docs/news.rst Outdated Show resolved Hide resolved
@Gallaecio
Copy link
Member Author

hey @Gallaecio! I also tried to put all pull requests for new changes in thee 1.7 milestone a few days ago (https://github.com/scrapy/scrapy/milestone/22), maybe this would help you. Not 100% sure all PRs are there though, I could have missed something, or added something which shouldn't be there.

Thanks! I’ll complete the release notes based on commits just to make sure I don’t miss anything, and then compare the result to the milestone to ensure that everything fits.

@Gallaecio
Copy link
Member Author

readthedocs/sphinx_rtd_theme#705 is making some list items look rather badly, I hope they fix it soon.

@Gallaecio
Copy link
Member Author

Current coverage:

While I’m confident about the coverage (as in I don’t think any issue is missing), I’m more than grateful for any feedback regarding everything else (e.g. content organization, header naming).

@Gallaecio Gallaecio marked this pull request as ready for review July 1, 2019 18:23
docs/news.rst Outdated Show resolved Hide resolved
@Gallaecio Gallaecio force-pushed the release-notes-1.7 branch 2 times, most recently from 06ee14a to 54a56a9 Compare July 2, 2019 15:38
@Gallaecio
Copy link
Member Author

Moved those 3 new features to the top, simplified the list of deprecations further to remove as much visual clutter as possible without loss of information, and covered #3692.

Current coverage: 4c755f1 + #3578

@Gallaecio
Copy link
Member Author

Added a note about Scrapy 2.0 dropping support for Python 2.

@Gallaecio
Copy link
Member Author

I’ll keep the description up-to-date with the release notes coverage.

@elacuesta
Copy link
Member

Hi there @Gallaecio, @kmike, have we reached feature freeze for 1.7 or is there a chance to include #3712 and #2400? Thanks!

docs/news.rst Outdated Show resolved Hide resolved
docs/news.rst Outdated Show resolved Hide resolved
@Gallaecio
Copy link
Member Author

Both suggestions applied.

I’ve also made some changes to the documentation from #3829 which include fixes for link syntax issues that I overlooked.

docs/news.rst Outdated
~~~~~~~~~~~~~

* ``scrapy.utils.gz.is_gzipped`` is now **deprecated**. Use
``scrapy.utils.gz.gzip_magic_number`` instead.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should it be moved to Deprecations section?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right! 🤦‍♂️

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

I’ve also moved the two deprecation comments from New features to Deprecations as well.

@Gallaecio Gallaecio force-pushed the release-notes-1.7 branch 2 times, most recently from 5b238fd to cd1a74f Compare July 11, 2019 07:40

* The ``queuelib.PriorityQueue`` value for the
:setting:`SCHEDULER_PRIORITY_QUEUE` setting is deprecated. Use
:class:`scrapy.pqueues.ScrapyPriorityQueue` instead.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually backwards incompatible: only exact queuelib.PriorityQueue class still works, its custom subclasses don't. See

if pqclass is PriorityQueue:

The main API change is that priority queue class now needs to support Request objects, not just general Python data structures; compare

class ScrapyPriorityQueue(PriorityQueue):
and https://github.com/scrapy/queuelib/blob/master/queuelib/pqueue.py.

I'm not sure how detailed should be our deprecation docs on this, as this API was not documented before, if I'm not mistaken.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’ve added a short entry to the backward incompatibility section, please have a look and share your thoughts.

@Gallaecio Gallaecio force-pushed the release-notes-1.7 branch 2 times, most recently from 76035f4 to d17f800 Compare July 11, 2019 10:09
@elacuesta
Copy link
Member

Added a note about Scrapy 2.0 dropping support for Python 2.

Can't wait for this. Don't get me wrong, I think six does an awesome job, but it'll be good to clean up the codebase.

@Gallaecio
Copy link
Member Author

Updated to fix #3872.

@Gallaecio
Copy link
Member Author

As part of the last updated, I’ve:

  • Installed the InterSphinx extension to easily link to external documentations also built using Sphinx, like Python’s. ChainMap served as an excuse for it 🙂
  • Grouped together a few of the documentation entries, to make the documentation section shorter.
  • Moved the entry about generating documentation coverage data to Other changes, as it’s meant for contributors, not users.

@Gallaecio Gallaecio force-pushed the release-notes-1.7 branch 2 times, most recently from 12654fa to 8624c9f Compare July 18, 2019 13:33
@Gallaecio Gallaecio merged commit a94b5be into scrapy:master Jul 18, 2019
@Gallaecio Gallaecio deleted the release-notes-1.7 branch June 14, 2020 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document changed CrawlerProcess.crawl(spider) functionality in Release notes
3 participants