Document how to make releases

[lopuhin]

TODO:

• try to follow this for 0.10.0 release

[codecov]

Codecov Report

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

@@           Coverage Diff           @@
##           master     #150   +/-   ##
=======================================
  Coverage   89.23%   89.23%           
=======================================
  Files          12       12           
  Lines         539      539           
  Branches      122      122           
=======================================
  Hits          481      481           
  Misses         52       52           
  Partials        6        6           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1c310c5...063e10b. Read the comment docs.

[lopuhin]

Sorry for the mess with multiple tried to make a release in master, original sequence didn't work and then I didn't notice that upload already succeeded on the next try. Documented the working sequence, hope it goes smoother next time.

[kmike]

Thanks @lopuhin!
The sequence makes sense to me, especially as you checked that it works :)

Do you think we can move it to wiki?
This is information for maintainers, not for general extruct users.

[lopuhin]

Do you think we can move it to wiki? This is information for maintainers, not for general extruct users.

@kmike good point, I can move it along with bumpversion mention. Another option besides the wiki is to have it in git, e.g. in RELEASE.rst or MAINTENANCE.rst for easier discoverability, what do you think?

[kmike]

I think both are fine, not strong preference. I've seen @Gallaecio updating release procedure in wiki almost on each release sometimes, when it's complex (in such case it looks better suited for wiki), but here it looks pretty straightforward.

[lopuhin]

Aha I didn't know we already use wiki for that purpose, nice, make sense to follow the same approach here.

[kmike]

We're not using it for this repo, but we have release procedure in wiki for Scrapy, Splash and some other Open Source packages we maintain - see e.g. https://github.com/scrapy/scrapy/wiki/Scrapy-release-procedure or https://github.com/scrapinghub/splash/wiki/How-to-make-a-Splash-release.

[lopuhin]

Thanks for context @kmike , makes sense to use a similar approach across our repos. Created a wiki page https://github.com/scrapinghub/extruct/wiki and removed stuff from the README.

[kmike]

Thanks @lopuhin for taking care of that!

[lopuhin]

thanks @kmike !