Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add minimum DPF version logic to examples #783

Merged
merged 9 commits into from
Feb 7, 2023
Merged

Conversation

PProfizi
Copy link
Contributor

@PProfizi PProfizi commented Feb 6, 2023

Managing the minimal DPF version required to run an example is necessary to be able to continue CI/CD with continuous integration of examples and features only available on the DPF server currently under development, but not yet in the one already out.
For now, this is specified with a note in the header of the example, stating for example:

.. note::
   This example requires DPF 6.1 or above.
   For more information, see :ref:`ref_compatibility`.

The two digits version number is used, however I think we could use the DPF Server package version if we wanted to.

See docs job as well as examples job for the 2023.2.pre0 server.

@codecov
Copy link

codecov bot commented Feb 6, 2023

Codecov Report

Merging #783 (a173e32) into master (5a92a48) will increase coverage by 0.21%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #783      +/-   ##
==========================================
+ Coverage   88.64%   88.86%   +0.21%     
==========================================
  Files          72       72              
  Lines        8157     8180      +23     
==========================================
+ Hits         7231     7269      +38     
+ Misses        926      911      -15     

@PProfizi
Copy link
Contributor Author

PProfizi commented Feb 6, 2023

Tested locally and works for gallery generation, like here with 00-basic_example.py declared as requiring 6.2 in a note:
image

@PProfizi PProfizi merged commit b747593 into master Feb 7, 2023
@PProfizi PProfizi deleted the feat/version_examples branch February 7, 2023 08:26
@PProfizi PProfizi linked an issue Feb 15, 2023 that may be closed by this pull request
3 tasks
@PProfizi PProfizi added the examples Related to PyDPF-Core examples label Feb 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples Related to PyDPF-Core examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CI release fails due to new example
2 participants