v0.6.0 #744

CagtayFabry · 2022-04-28T20:23:43Z

Changes

release 0.6.0

How to release

A short primer in the steps needed to release a new version of the weldx package

create release PR

create a PR that finalizes the code for the next version
- name the PR according to the version vX.Y.Z and add the release
  tag (example here)
- make sure CHANGELOG.rst is up to date and enter current date to the release version
- add summarized release highlights where appropriate
- update the CITATION.cff version number and date
- search the project for deprecated and remove deprecated code
wait for CI jobs to finish
check the readthedocs PR build
wait for reviews

Merge the Pull Request

merge normally and wait for all CI actions to finish on the main branch

add Git(hub) tag

tag and release the current master version on GitHub using the Releases feature
- name the release git tag according to the version released (e.g. v0.3.3)
- name the GitHub release accordingly, omitting the v prefix (this can be change later so don't worry, in
  doubt use vX.Y.Z everywhere)
- copy the changes/release notes of the current version into the description
  (this website can be used to convert rST -> MD)
wait for all Github Actions to finish

ReadTheDocs update

check the build processes for latest, stable and vX.Y.Z get triggered on RTD (the tag build can get
triggered twice, resulting in a failed/duplicated build, no need to worry)

pypi release

check the automatic release to pypi after the build action completes here

conda-forge release

pypi release should get picked up by the conda-forge bot and create the new
pull-request here
carefully check the meta.yaml in the pull request, manually update all changes in the build and run dependencies
merge with 2 or more approved reviews

github-actions · 2022-04-28T20:31:12Z

Unit Test Results

      1 files ±0       1 suites ±0 2m 36s ⏱️ - 1m 8s
2 146 tests ±0 2 146 ✔️ ±0 0 💤 ±0 0 ❌ ±0

Results for commit cd47450. ± Comparison against base commit a1e7184.

♻️ This comment has been updated with latest results.

CagtayFabry · 2022-04-28T20:43:41Z

draft of the GitHub release: https://github.com/BAMWelDX/weldx/releases/tag/untagged-b904093fe4d4ade154f6

codecov · 2022-04-28T20:53:56Z

Codecov Report

Merging #744 (cd47450) into master (a1e7184) will decrease coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #744      +/-   ##
==========================================
- Coverage   95.85%   95.82%   -0.04%     
==========================================
  Files          92       92              
  Lines        6520     6516       -4     
==========================================
- Hits         6250     6244       -6     
- Misses        270      272       +2

Impacted Files	Coverage Δ
weldx/asdf/file.py	`96.20% <ø> (-0.40%)`	⬇️
weldx/asdf/util.py	`90.32% <0.00%> (-0.33%)`	⬇️

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 a1e7184...cd47450. Read the comment docs.

CagtayFabry · 2022-04-28T21:10:22Z

weldx/tests/asdf_tests/test_weldx_file.py

-        # try to obtain key from underlying dict.
-        with pytest.raises(KeyError), pytest.warns(WeldxDeprecationWarning):
-            _ = self.fh.data[protected_key]


can this be deleted now? @marscher

For some reason the first line below "changes" in the RTD version of the changelog is shown in bold letters:

https://weldx--744.org.readthedocs.build/en/744/changelog_link.html

Checked the changelog file and the only difference to the other lines that I could find is that the line in question has only a single space between the - and the text while all others have 2 spaces. I am not that familiar with RST, but I guess that's the problem.

@CagtayFabry you were absolutely right about this deletion.

@vhirtham RST is sometimes also very picky with missing line breaks. But this should not cause usage of bold setting...

good find @vhirtham , let's see if it is fixed with the spaces (otherwise we can reformat later)

@marscher argh... this should have been an extra comment ... ooops. Well let's see what fixes it

review-notebook-app · 2022-04-28T21:16:38Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

CHANGELOG.rst

Co-authored-by: vhirtham <volker.hirthammer@bam.de>

vhirtham · 2022-04-29T08:52:37Z

CHANGELOG.rst

 ********************

+This release includes major changes to the handling and support of units in the API and ASDF schemas. All classes now support and require quantities where appropriate. Pure unitless numbers are no longer supported.
+


Suggested change

Furthermore, a new class called `GenericSeries` was added. It provides a common interface to describe coordinate-based data either by discrete values or mathematical expressions. A built-in mechanism lets you derive specialized series with specific requirements. For more information, have a look [at the new tutorial](https://weldx.readthedocs.io/en/v0.6.0/tutorials/generic_series.html)

Since somebody already merged the suggestion while I was editing it for additional content 😄

safer to edit directly in the file I guess 😉

CagtayFabry added 2 commits April 28, 2022 22:20

update CHANGELOG.rst and CITATION.cff

adb9427

remove deprecation

1f77bd2

CagtayFabry added the release label Apr 28, 2022

CagtayFabry assigned marscher and vhirtham Apr 28, 2022

CagtayFabry added the no-changelog-entry-needed label Apr 28, 2022

remove deprecated test

5f0bf22

update CHANGELOG.rst

9e56055

CagtayFabry requested review from marscher and vhirtham April 28, 2022 20:43

CagtayFabry commented Apr 28, 2022

View reviewed changes

update tutorials

6dbf88c

vhirtham reviewed Apr 29, 2022

View reviewed changes

CHANGELOG.rst Show resolved Hide resolved

Update CHANGELOG.rst

e797c06

Co-authored-by: vhirtham <volker.hirthammer@bam.de>

marscher approved these changes Apr 29, 2022

View reviewed changes

[changelog] try to fix bold setting in changes section

5aadc50

vhirtham reviewed Apr 29, 2022

View reviewed changes

marscher and others added 3 commits April 29, 2022 10:58

[changelog] give an example, how unit-less numbers have to be wrapped

b3dad32

Update CHANGELOG.rst

73a684c

update CHANGELOG.rst

cd47450

vhirtham approved these changes Apr 29, 2022

View reviewed changes

CagtayFabry merged commit b7f599a into master Apr 29, 2022

CagtayFabry deleted the v0.6.0 branch April 29, 2022 10:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

v0.6.0 #744

v0.6.0 #744

CagtayFabry commented Apr 28, 2022 •

edited

Loading

github-actions bot commented Apr 28, 2022 •

edited

Loading

CagtayFabry commented Apr 28, 2022

codecov bot commented Apr 28, 2022 •

edited

Loading

CagtayFabry Apr 28, 2022

vhirtham Apr 29, 2022

marscher Apr 29, 2022

CagtayFabry Apr 29, 2022

vhirtham Apr 29, 2022 •

edited

Loading

review-notebook-app bot commented Apr 28, 2022

vhirtham Apr 29, 2022 •

edited

Loading

CagtayFabry Apr 29, 2022

		********************

		This release includes major changes to the handling and support of units in the API and ASDF schemas. All classes now support and require quantities where appropriate. Pure unitless numbers are no longer supported.



	Furthermore, a new class called `GenericSeries` was added. It provides a common interface to describe coordinate-based data either by discrete values or mathematical expressions. A built-in mechanism lets you derive specialized series with specific requirements. For more information, have a look [at the new tutorial](https://weldx.readthedocs.io/en/v0.6.0/tutorials/generic_series.html)

v0.6.0 #744

v0.6.0 #744

Conversation

CagtayFabry commented Apr 28, 2022 • edited Loading

Changes

How to release

create release PR

Merge the Pull Request

add Git(hub) tag

ReadTheDocs update

pypi release

conda-forge release

github-actions bot commented Apr 28, 2022 • edited Loading

Unit Test Results

CagtayFabry commented Apr 28, 2022

codecov bot commented Apr 28, 2022 • edited Loading

Codecov Report

CagtayFabry Apr 28, 2022

Choose a reason for hiding this comment

vhirtham Apr 29, 2022

Choose a reason for hiding this comment

marscher Apr 29, 2022

Choose a reason for hiding this comment

CagtayFabry Apr 29, 2022

Choose a reason for hiding this comment

vhirtham Apr 29, 2022 • edited Loading

Choose a reason for hiding this comment

review-notebook-app bot commented Apr 28, 2022

vhirtham Apr 29, 2022 • edited Loading

Choose a reason for hiding this comment

CagtayFabry Apr 29, 2022

Choose a reason for hiding this comment

CagtayFabry commented Apr 28, 2022 •

edited

Loading

github-actions bot commented Apr 28, 2022 •

edited

Loading

codecov bot commented Apr 28, 2022 •

edited

Loading

vhirtham Apr 29, 2022 •

edited

Loading

vhirtham Apr 29, 2022 •

edited

Loading