Added Towncrier #20

Patil2099 · 2019-11-09T17:07:54Z

What was wrong?

closes #16

How was it fixed?

Towncrier added
Relevant configs added and borrowed from the ethereum-python-project-template repo
Relevant newsframents added from recent updates to master

Cute Animal Picture

.github/PULL_REQUEST_TEMPLATE.md

pyproject.toml

newsfragments/validate_files.py

pyproject.toml

cburgdorf · 2019-11-11T16:00:33Z

@Patil2099 Thanks for jumping on this! Just a few minor corrections needed, overall looks good :)

pyproject.toml

newsfragments/validate_files.py

Patil2099 · 2019-11-12T09:02:10Z

@cburgdorf Is this correct now?

.github/PULL_REQUEST_TEMPLATE.md

pyproject.toml

Patil2099 · 2019-11-12T09:30:16Z

@cburgdorf Is this correct now?
Let me know if changes are needed

cburgdorf · 2019-11-12T09:41:00Z

@cburgdorf Is this correct now?

I strongly encourage you to actually try it out and see if it works. E.g. you might (temporary) comment out the critical lines of the make release command which deals with signing or pushing the tags somewhere but leave in the rest and then run make release bump=minor and check if it works as expected. Check if the release notes are produced and accessible as they should.

Without actually running and confirming the changes it will be really hard to come up with something that is correct.

From what I see (without running the code, which is something that I'll have to do before I merge this) I can at least say that the TOC still has a wrong reference to the changelog (releases instead of release_notes)

https://github.com/ethereum/eth-typing/blob/master/docs/index.rst#L13

cburgdorf · 2019-11-29T11:59:04Z

Hey @Patil2099 sorry for the late reply. We've lately made some changes to our towncrier setup and it would be best to just resync with the template project that this repo is based on.

We have some instructions on how to do that:
https://github.com/ethereum/snake-charmers-tactical-manual/blob/master/template.md#upgrading-a-repo-to-use-the-latest-templated-features

Would you be willing to update this PR again? If not that's fine, too, I can also take care of it.

Patil2099 · 2021-02-12T08:20:30Z

@cburgdorf sorry for replying so late was going through all the prs. What can I do to get this pr merged I can make any changes. Thanks.

fselmo · 2022-06-17T17:28:53Z

closing due to staleness

fselmo · 2022-06-20T20:08:14Z

Actually, my fault @Patil2099... This is not as stale as I thought 🙂! We have just updated a few things across the ethereum libraries since this was worked on... I'm going to add the commits from PR #31 on top of this since you made most of these changes already.

Thanks so much for submitting this... sorry it took us a while to get to it 👍

* Add towncrier * Fixed Docs Ref. * Fixed Broken Links * Fixed pyproject * Docs Fixed

* Update towncrier version in ``setup.py`` * Update Makefile * Update /newsfragments' supporting files with the updated setup from the `ethereum-python-project-template` repo * Update `tox.ini` and CI's `config.yaml` * Update `pyproject.toml`

kclowes

This looks good to me! I just split out a new make command (validate-docs). Thanks @Patil2099 for the PR and for your patience!

cburgdorf requested changes Nov 11, 2019

View reviewed changes

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

pyproject.toml Outdated Show resolved Hide resolved

newsfragments/validate_files.py Outdated Show resolved Hide resolved

pyproject.toml Show resolved Hide resolved

Patil2099 requested a review from cburgdorf November 12, 2019 05:23