@jerome, thanks for this. I have only minor suggestions:
- the rest of the changelog uses
( commit )(note the extra spaces in between braces and content. It would be good to use consistent style throughout the whole document;
- I'm not a native english speaker, but one thing caught my eye:
... from on going pull ...(note the space in between
going). Maybe that should be changed to
... from ongoing pull ...(note no space in
Thanks also for catching
*.txtnot being explicitly listed there in MANIFEST.
- the rest of the changelog uses
Thanks also for catching *.txt not being explicitly listed there in MANIFEST.
I remembered I had to do this, but I think that this kind of mistakes are anyway catched when following the wendelin release procedure. The step of unpacking the dist tarball and running tests again should have failed.
One mistake that I did first was something wrong with the rst syntax, a missing blank line. I only noticed when uploading a first time on test pypi. To prevent thisi, I'd like to suggest an amendment to the wendelin release procedure, to include a
twine checkstep, which warns about these mistakes. I submitted a new version at https://nexedi.erp5.net/web_page_module/9202/ . I also changed lab.nexedi.cn to lab.nexedi.com in that page, I hope that's also OK.
@jerome, thanks for feedback and fixes.
*.txtwas not caught earlier, because setuptools, by defaufault, include MANIFEST.txt or some other simialr file. With our input vector txt neeeds to be included explicitly and it is generally better that we have all files included into the manifest explicitly without relying on setuptools implicit behaviour.
twine checkand updating the release howto. I will have a closer look at your edits a bit later today.
@jerome, thanks again. I've reviewed your edits on the howto and they look good. To review how RST rendering looks I can also suggest the following:
rst2html CHANGELOG.rst x.htmland check how x.html looks in the browser;
- when the release commit is pushed onto lab.nexedi.com, even in some personal place in draft state, it is possible to go to that project/tree/sha, and there go to changelog, similarly to https://lab.nexedi.com/nexedi/zodbtools/blob/master/CHANGELOG.rst . Then it also shows the rendering.
All this can help to verify not only that we have correct rst syntax, but that the document also looks right visually.
Thanks once again for the how-to update. Could you please mark the older 001 version as no longer shared (= Archived) and make 002 shared alive?
Because you confirmed, I shared the version 002 ( which automatically archives old version of document with same reference, this is how document management works in ERP5 ). For the records, I had to do this with my "super user" account. My normal user is not member of wendelin project so I don't have permissions to do this - and no permission to view this document either. I feel this is not confidential at all and could even be made in "published" state, but I left it as it was before.
@jerome, yes, thanks for feedback. Yes, this is not confidential at all and could be imho made public. I've tried to adjust classification and Follow-ups but the document is still not yet publicly visible. Unfortunately I don't have rights to "publish alive", but probably the adjustments should be enough for regular Nexedians to see the document. Please feel free to ammend the access settings if it is not the case and if you can make it public.
@jerome, thanks. I confirm that https://www.nexedi.com/P-WIA-Wendelin.Core.Release.Howto now works, thanks for publishing it. Should we drop
P-WIAfrom the reference, since the document is not
I feel it's OK to keep it as
P-WIAfor now, because the document uses
wendelin.corein the commands and some steps are specific to wendelin ( the way of running tests). We could make a general guideline with this one and some other "how to make release" documents we have for ERP5 and SlapOS.