Revise release note scripting

[prjemian]

to fix #728 and (fix #729)

[prjemian]

Example output

command: ./create_release_notes.py v2018.5 "NXDL 2020.1" MY_PAT | tee /tmp/output.md

(substituting my personal access token for MY_PAT)

---

NXDL 2020.1

• date/time: 2020-01-26 11:37:55.455740
• release:
• documentation: PDF
• milestone: NXDL 2020.1

section	quantity
New Tags	2
Pull Requests	40
Issues	50
Commits	196

Tags

tag	date	name
09fd569	2020-01-24	create_zenodo_doi
4f6ef8d	2020-01-24	v2020.1rc1

Pull Requests

pull request	date	state	title
#612	2020-01-18	merged	Document concepts of the new geometry description
#614	2020-01-23	merged	Pdb (new base class) in nexus
#627	2018-10-24	merged	Nxquadric 1
#628	2020-01-23	merged	NXcxi_ptycho contributed definition
#635	2020-01-25	merged	define diffractometer in NXinstrument -- issue 632
#637	2020-01-25	merged	sphinx configuration - issue 631
#644	2020-01-18	merged	Fix NXtransformation example
#646	2019-01-21	merged	Correct a typo in NXsolid_geometry.nxdl.xml
#649	2020-01-18	merged	Changes to fields and description of NXdisk_chopper
#652	2020-01-23	merged	Clarify data_origin and data_size. Resolves #650.
#654	2020-01-23	merged	Allow multi-image masks. Resolves #651.
#655	2020-01-23	merged	Add per-image dynamic_mask as option for NXdetector. Resolves #651.
#657	2020-01-24	merged	Added time-stamp strategy documentation
#666	2020-01-23	merged	Added documentation for variants to datarules.rst
#669	2020-01-23	merged	NXmx: add NXsource and make name in NXsource and NXinstrument required
#672	2020-01-25	merged	resolve Sphinx errors
#675	2020-01-25	merged	long_name values swapped in verysimple example
#678	2020-01-25	closed	NXdetector drawings
#679	2020-01-25	merged	additional NXdetector documentation
#684	2020-01-25	merged	sync this branch with master
#685	2020-01-25	merged	integrate NIAC decision on errors & uncertainties
#686	2020-01-25	closed	sync this branch with master
#690	2020-01-25	merged	change "guess" highlight to language-specific
#694	2020-01-17	merged	change NXparameter to NXparameters
#698	2020-01-25	merged	Use consistent terms in manual when names are flexible.
#701	2020-01-23	merged	Clarify documentation to fix #307
#702	2020-01-26	merged	Ticket663 use gh pages
#704	2020-01-23	merged	Clarify note on IUCr coordinate system.
#706	2020-01-23	closed	Per shot wavelength
#707	2020-01-25	merged	adjust links for h5toText, now punx tree
#710	2020-01-23	merged	Correct slow/fast pixel direction documentation to fix #695
#713	2020-01-25	merged	copyright 2020
#715	2020-01-25	merged	certain unit tests had failed
#716	2020-01-23	closed	Set minOccurs to zero for unneeded items in NXsource of NXmx
#717	2020-01-23	merged	Per shot wavelength, second try
#718	2020-01-25	merged	update Sphinx config to 2.3.1
#719	2020-01-23	merged	Improved documentation about time stamped data
#722	2020-01-23	merged	Remove some references to NAPI for #699
#723	2020-01-25	merged	describe field suffixes reserved by NeXus
#726	2020-01-25	merged	cleanup in nxdl.xsd

Issues

issue	date	title
#45	2018-05-08	Review: NXmirror
#307	2020-01-23	NXDL data type vs NAPI type vs NeXus data type: clarify and simplify!
#331	2018-10-25	review rarely used NXDL attributes
#370	2020-01-23	more prominently document existing scheme for uncertainties
#471	2018-10-26	NXenvironment is of dubious value
#503	2020-01-23	Recording time-stamped data
#531	2020-01-21	docs: add text when a group name is suggested
#532	2020-01-22	add "uncertainties" attribute to fieldType in nxdl.xsd
#553	2020-01-21	Create structure to incorporate PDB definitions into NeXus
#562	2020-01-21	use consistent terms when names are flexible
#585	2018-10-26	NXslit: add blade positions: top, left, bottom, right
#615	2018-05-08	problems with pdb documentation
#624	2018-05-16	./utils/create_release_notes.py
#625	2018-10-26	What file extension to use?
#626	2018-10-26	Create DOI for current NeXus definitions release
#631	2018-10-26	update the sphinx configuration
#632	2019-05-14	define diffractometer in NXinstrument
#633	2018-10-25	in NXdata, field "errors" should be "ERRORS"
#634	2020-01-23	NIAC has decided about how to report errors/uncertainties
#638	2018-10-26	description strings should be reworded
#650	2019-04-03	data_origin and data_size documentation is unclear
#651	2019-08-01	Need per-image pixel mask
#658	2019-08-07	Build failed in Jenkins: definitions-master
#659	2020-01-23	update Sphinx config
#660	2019-05-13	add py3.6 and py3.7 to travis-ci tests
#661	2019-05-13	nxdl2rst.py needs an update
#662	2019-05-13	reST syntax error
#663	2020-01-23	consider publishing docs in GitHub pages
#664	2019-05-14	NXtransformations.rst (converted file) Inline literal start-string without end-string
#667	2020-01-23	How to specify per-shot wavelength
#670	2019-07-28	Sphinx build errors
#673	2020-01-15	create "Change History" file
#674	2019-08-21	Wrong long_name in verysimple example
#676	2019-08-21	Build failed in Jenkins: definitions-master #398
#677	2019-08-21	verysimple: one more file to fix
#680	2020-01-21	close branch pixel_as_length_issue_511
#689	2019-10-11	WARNING: Could not lex literal_block as "guess". Highlighting skipped.
#691	2019-10-11	WARNING: Could not lex literal_block as "c". Highlighting skipped.
#695	2020-01-23	Slow/fast axis inconsistent in NXdetector_module
#696	2020-01-23	NXmx has fields that may not have to be required
#700	2020-01-22	Is use of UPPER case names described in the manual?
#705	2020-01-22	Need new links to h5toText program
#712	2020-01-22	update copyright date to 2020
#714	2020-01-22	some unit tests fail since flexible names are UPPER case
#720	2020-01-23	PDF manual does not build
#721	2020-01-23	DATASET_errors naming convention should appear in manual
#725	2020-01-23	cleanup in nxdl.xsd
#729	2020-01-26	create_release_notes.py should use SHA credentials
#732	2020-01-24	Makefile can't build the PDF manual
#733	2020-01-24	editing needed in datarules.rst new content

Commits

commit	date	message
0675e79	2017-08-08	Introduce NXcif to hold a complete CIF in a NeXus file -- HJB
d387bfe	2017-08-08	Fix ragged spacing caused by inconsistent use of tab -- HJB
529a527	2017-08-08	Change NXcif to NXpdb -- HJB
afbbe88	2017-08-08	Fix doc spacing error in NXpdb. There is still a manual build error
07a21a3	2018-03-13	Merge branch 'master' into pdb_in_nexus
b241f15	2018-03-14	remove references to NXcollection
518a1dc	2018-03-18	rebuild should be easier
df4e704	2018-03-18	fix #615
d16d685	2018-04-26	Fixed sequence_number in NXdetector be of type NX_INT
9475707	2018-05-14	Merge branch 'master' into pdb_in_nexus
7f3e976	2018-05-15	release steps 10-11: publish the manual
1aa7397	2018-05-15	point to the release procedure wiki
2dc081e	2018-05-16	fixes #624: generalized to find org & repo
e4891f8	2018-09-07	add dropped _zero
4fc648d	2018-10-24	Nxquadric 1 (#627)
e1d0638	2018-10-26	Add changes as of 26 Oct 2018, to reflect code in CBFlib cif2cbf
397f06c	2018-10-26	Minor edits -- HJB
061bc6a	2018-10-26	add whitespace after full space
09fd569	2018-10-26	sphinx configuration - issue 631 (#637)
104787d	2018-10-26	add Zenodo DOI badge
8c3898a	2018-10-26	DOI in text (in case the badge graphic fails)
f43c4c5	2018-10-26	fixes #638
2f52f1a	2018-10-26	FAQ: what file extension to use? fixes #625
6433507	2018-10-26	Fix travis-ci errors report by PJ -- HJB
4dddb6d	2018-10-26	fixes #638
d550abd	2018-10-27	NXptycho contributed definition (#628)
5c5dbe6	2018-10-27	Document concepts of the new geometry description (#612)
f582f23	2018-11-05	#634 NXdata
a30df1f	2018-11-05	#634
a405fb0	2018-12-14	re #643 fix NXtransformation example
8b52a0d	2018-12-14	re #643 depends_on as field of component
aafc1c1	2018-12-14	Update euler-cif.txt
9942817	2019-01-21	Correct a typo in NXsolid_geometry.nxdl.xml (#646)
d548854	2019-03-19	Update euler-cif.txt
4a3304f	2019-03-19	Changes to fields and description of NXdisk_chopper
72b030c	2019-03-19	Update phase definition for NXdisk_chopper
c9c5466	2019-03-27	Clarify data_origin and data_size. Resolves #650.
4925eeb	2019-03-28	Allow multi-image masks. Resolves #651.
9a0825d	2019-04-02	Restore slit_angle, make new field slit_edges
081e36a	2019-04-02	Restore phase, make new field delay
17d1952	2019-04-02	Restore removed fields
3113165	2019-04-02	Update NXdisk_chopper.nxdl.xml
97dc27a	2019-04-02	Clarify dimensionality of data_origin
dd7bcfd	2019-04-02	Bit more clarity.
b4475d5	2019-04-03	Merge pull request #652 from nexusformat/data_origin
fbca3e9	2019-04-03	Merge pull request #654 from nexusformat/multiimage_mask
4149c83	2019-04-24	fixes #648
edaa967	2019-04-24	Add underload_value to NXdetector. Fixes #656.
bd084c8	2019-05-09	Added timestamp documentation
7da5be5	2019-05-09	Corrected text
9128940	2019-05-10	Added more robust git link
757daf0	2019-05-10	Merge pull request #657 from nexusformat/503_timestamped_data
4a4f029	2019-05-13	#614 add missing verion attribute
080a842	2019-05-13	#614 require "version" attribute
29d3db6	2019-05-13	#614 remove "version" attribute (both NXDL and Py)
02943f4	2019-05-13	#614 version is required (see nxdl.xsd, line 230)
4acc2f6	2019-05-13	#614 revert today's change
ed32d82	2019-05-13	Merge branch 'master' into pdb_in_nexus
b6a370c	2019-05-13	#614 finally: remove version attribute
60a95ba	2019-05-13	for developer's use on local build host
56f509a	2019-05-13	fixes #662
6e1a8f6	2019-05-13	#660
d748753	2019-05-13	fixes #661
9647e0f	2019-05-14	Merge pull request #614 from nexusformat/pdb_in_nexus
1454aa2	2019-05-14	define diffractometer in NXinstrument -- issue 632 (#635)
b4c9e51	2019-05-14	fixes #664
88a8689	2019-05-21	Add array description for slit_angle and slit_height
17b5b44	2019-05-23	Revert "Add array description for slit_angle and slit_height"
d0a3574	2019-05-23	Restore single line summary to start of class description
8ed3afa	2019-05-23	Use tab for indentation to be consistent with rest of file
f9836c5	2019-05-23	Use tab for indentation to be consistent with rest of file
5fc09fb	2019-05-23	Added documentation for variants to datarules.rst
57df137	2019-05-28	Add start attribute for TDC times
8107c5d	2019-05-28	Specifiy sign of chopper direction relative to source, not sample
f3271c0	2019-05-29	Merge pull request #649 from matthew-d-jones/Changes_to_NXdisk_chopper
935afe4	2019-05-29	refs #694
9037cbd	2019-05-29	Merge pull request #644 from matthew-d-jones/643_fix_NXtransformations_example
99a2434	2019-05-31	update affiliation
776f372	2019-05-31	Merge branch 'master' of github.com:nexusformat/definitions
710ca17	2019-05-31	test jenkins build
40225e3	2019-07-28	DOC #670 pygments
bfaf218	2019-07-28	Merge pull request #672 from nexusformat/670-sphinx-errors
681e968	2019-08-01	From HDRMX meeting at ACA 2019. Add required name to NXinstrument. Add NXsource as copy of NXsource base class but make name required.
6d0c900	2019-08-01	Add per-image dynamic_mask as option for NXdetector. Resolves #651.
29de7d8	2019-08-01	Clarify language taking into account #654.
7392a0f	2019-08-01	From telco, use pixel_mask_N instead of dynamic_mask
5ebbd55	2019-08-01	Spelling
c2eebbe	2019-08-07	DOC #673
301052d	2019-08-07	DOC #673
7078cc2	2019-08-07	DOC #673 additional content
977b3bd	2019-08-07	DOC #673 show versioning change, reformat
fd3d7b1	2019-08-07	DOC #673
d94855b	2019-08-21	MNT #674
657b751	2019-08-21	DOC #674
8fd7719	2019-08-21	Merge pull request #675 from nexusformat/674-verysimple
94301d5	2019-08-21	fixes #677
2ee95a3	2019-08-25	DOC #412
abfd9b8	2019-08-25	DOC #412 drawings from Eugen
9674194	2019-08-25	DOC #412 instructions
cb128a9	2019-08-25	Merge pull request #679 from nexusformat/412_NDdetector-drawings
acf729e	2019-09-11	locate NXDL files
f4d7a17	2019-09-11	Merge branch 'master' into 634-sync-master
8c41b46	2019-09-11	Merge pull request #684 from nexusformat/634-sync-master
859529f	2019-10-11	MNT #289
5951884	2019-10-11	MNT #689
8d761cb	2019-10-11	Merge pull request #690 from nexusformat/689_guess
8c2e568	2019-10-11	fixes #691
214a353	2019-11-08	fix spelling
10a32d9	2019-11-20	change NXparameter to NXparameters
b011858	2019-11-20	Merge pull request #694 from jkotan/nxparameter
5244228	2020-01-21	MNT #562 ignore VSCode config files
7b89fee	2020-01-21	TST #562
67e4544	2020-01-21	fixes #531
dd100b8	2020-01-21	Merge pull request #698 from nexusformat/562-flexible-names
36bc94e	2020-01-21	Build for github pages
2c89d95	2020-01-21	Corrected text for Variants section
2f09650	2020-01-22	Merge pull request #666 from nexusformat/variants
6db2e77	2020-01-22	Fxi links
80dca9b	2020-01-22	Fix links
cba11d2	2020-01-22	Fix expansion
b77ca05	2020-01-22	fixes #705
3821e10	2020-01-22	Clarify documentation to fix #307
a787c0d	2020-01-22	MNT #707 per review
adec2be	2020-01-22	use https
31b2ca5	2020-01-22	Merge pull request #707 from nexusformat/705-h5toText-changes
1438bfa	2020-01-22	Fix broken links
1e6274e	2020-01-22	Merge remote-tracking branch 'origin/master' into Ticket663_use_gh_pages
6a4c02d	2020-01-22	ENH #712 work with py3
0eeaea5	2020-01-22	DOC #712 (c) 2020
30bab98	2020-01-22	Merge pull request #713 from nexusformat/712-copyright-2020
05ad425	2020-01-22	Fix remaining links
b09cf65	2020-01-22	fixes #714
143ce55	2020-01-22	Merge pull request #715 from nexusformat/714-unit-tests
c875d09	2020-01-23	fixes #659
2268c7b	2020-01-23	Py2 fix for nxdl2rst.py
0ce9edb	2020-01-23	Extend incident_wavelength to allow per-shot variation
194ffc0	2020-01-23	Code review from code camp
73355a4	2020-01-23	TST #659 drop Py2.7 from travis-ci
8eaa554	2020-01-23	Merge pull request #718 from nexusformat/659-Sphinx-config
7e2e22f	2020-01-23	Improved documentation about time stamped data
b64bb10	2020-01-23	Updated data rules to contain the NIAC decision on errors
dffa40e	2020-01-23	MNT #720 build PDF with addition option
f755da7	2020-01-23	MNT #720 one more instance
3198980	2020-01-23	Clarify note on IUCr coordinate system.
c5e4562	2020-01-23	MNT #720 build PDF by steps
eafd1af	2020-01-23	Merge branch 'master' of https://github.com/nexusformat/definitions
52f3e70	2020-01-23	Correct slow and fast pixel direction definitions to fix #695
1ef6a46	2020-01-23	Add slow and fast dimensions explanation to index
53f79d6	2020-01-23	Change links to reST references, add to index and fix typo
8d6d5b9	2020-01-23	Merge branch 'master' of https://github.com/nexusformat/definitions
ebd47b3	2020-01-23	MNT #720 typo excised
b12b9c0	2020-01-23	MNT #720 run pdflatex twice
775bb9c	2020-01-23	MNT #720 ignore first pdflatex fail
d571b74	2020-01-23	MNT #720 now try this
185de86	2020-01-23	MNT #720 force index to build
4915f0d	2020-01-23	Merge remote-tracking branch 'origin/master' into Ticket663_use_gh_pages
6759a1e	2020-01-23	Update jenkins build
622ebff	2020-01-23	Merge pull request #702 from nexusformat/Ticket663_use_gh_pages
f07e2e9	2020-01-23	Preserve CNAME for custom domain
ed1dc39	2020-01-23	Preserve CNAME for custom domain
9449216	2020-01-23	Fix path
b0c505c	2020-01-23	Remove some references to NAPI for #699
6e6d4cf	2020-01-23	DOC #721 describe reserved field suffixes
0fa6d64	2020-01-23	Tweak single phrase
af7df8a	2020-01-23	Ensure heading markdown lines up
d888548	2020-01-23	Final markup alignment
308446e	2020-01-23	fixes #725
ba5a141	2020-01-23	remove "_axes" from table
e7795fd	2020-01-23	Merge pull request #723 from nexusformat/721-DATASET_errors
f903783	2020-01-23	Merge pull request #726 from nexusformat/725-cleanup
d882580	2020-01-23	Update nxdlTypes.xsd
13be3e6	2020-01-23	Fix epics links
3331a31	2020-01-23	Merge branch 'master' of https://github.com/nexusformat/definitions
bb6be52	2020-01-23	Merge pull request #701 from nexusformat/datatype-consistency-307
47f8ddf	2020-01-23	Merge pull request #722 from nexusformat/remove-napi-references
af85397	2020-01-23	Update manual/source/strategies.rst
ae09b8d	2020-01-23	Update manual/source/strategies.rst
b5972c1	2020-01-23	Update manual/source/strategies.rst
0ecd81a	2020-01-23	Update manual/source/strategies.rst
4f6ef8d	2020-01-23	Update NXDL version for release candidate
ed2365f	2020-01-23	Update manual/source/rules.rst
d5cf737	2020-01-23	Update manual/source/rules.rst
7e4182e	2020-01-23	language improvement
e274131	2020-01-23	Update introduction.rst
bf4322a	2020-01-23	Update rules.rst
e7e4193	2020-01-23	Update strategies.rst
5326c9a	2020-01-23	Merge pull request #719 from nexusformat/503-time-stamped-data
7c8f3aa	2020-01-23	Only new build
f3a09a1	2020-01-23	added type="NX_FLOAT" to energy field for monochromator
9d846cf	2020-01-23	Merge branch 'master' into errors_uncertainties_634
b58410c	2020-01-23	TST #634 GitHub API creds changed
6531416	2020-01-23	Revert "added type="NX_FLOAT" to energy field for monochromator"
f33244e	2020-01-23	Merge pull request #685 from nexusformat/errors_uncertainties_634
508170b	2020-01-23	[releng] Publish the manual for release candidate
e11f332	2020-01-24	fixes #732
4f2782b	2020-01-24	fixes #733

[PeterC-DLS]

Does not work for me with

[remote "origin"]
	fetch = +refs/heads/*:refs/remotes/origin/*
	url = git@github.com:nexusformat/definitions.git

in my repo's .git/config

[PeterC-DLS]

Please check over my change

[prjemian]

@PeterC-DLS - Good catch, your change works for me, too. Mine is:

[remote "origin"]
	url = https://github.com/nexusformat/definitions
	fetch = +refs/heads/*:refs/remotes/origin/*

If otherwise good, then please merge. Delete branch, too.