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.

Sign up for GitHub

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

Feat/add release checklist #427

Merged
merged 6 commits into from
Feb 20, 2024
Merged

Feat/add release checklist #427

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
34cf3be
Add release checklist and add missing version to compatibility
janvonrickenbach Feb 19, 2024
ba77a68
Add missing link
janvonrickenbach Feb 19, 2024
54b9be6
Merge branch 'main' into feat/add_release_checklist
janvonrickenbach Feb 20, 2024
a9469b4
Complete release checklist and add tests for the newly tagged version.
janvonrickenbach Feb 20, 2024
dad7464
Merge remote-tracking branch 'origin/feat/add_release_checklist' into…
janvonrickenbach Feb 20, 2024
7d6ea6a
Merge branch 'main' into feat/add_release_checklist
janvonrickenbach Feb 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/source/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@
- ansys.dpf.composites Python module version
* - 8.0 (Ansys 2024 R2 pre0)
- 0.3.0 and later
* - 7.0 (Ansys 2024 R1)
- 0.3.0 and later
* - 7.0 (Ansys 2024 R1 pre0)
- 0.3.0 and later
* - 6.2 (Ansys 2023 R2)
Expand All @@ -128,8 +130,8 @@

.. _Get DPF Docker image:

Getting the DPF Server Docker Image

Check warning on line 133 in doc/source/intro.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/intro.rst#L133 

[Google.Headings] 'Getting the DPF Server Docker Image' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Getting the DPF Server Docker Image' should use sentence-style capitalization.", "location": {"path": "doc/source/intro.rst", "range": {"start": {"line": 133, "column": 1}}}, "severity": "WARNING"}
"""""""""""""""""""""""""""""""""""
Follow the steps described in the DPF documentation in the section `Run DPF Server in A Docker Container <https://dpf.docs.pyansys.com/version/stable/user_guide/getting_started_with_dpf_server.html#run-dpf-server-in-a-docker-container>`_.
Make sure you also download the composites plugin (e.g ``ansys_dpf_composites_lin_v2024.1.pre0.zip``).
After following the steps above, you should have a running DPF docker container that listens to port 50052.

Check warning on line 137 in doc/source/intro.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/intro.rst#L137 

[Google.WordList] Use 'preceding' instead of 'above'.
Raw output 
{"message": "[Google.WordList] Use 'preceding' instead of 'above'.", "location": {"path": "doc/source/intro.rst", "range": {"start": {"line": 137, "column": 27}}}, "severity": "WARNING"}
2 changes: 2 additions & 0 deletions release_checklist.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* Update the compatibility in the docs: intro.rst / Compatibility
* Follow this guide (https://dev.docs.pyansys.com/how-to/releasing.html) to create a release branch. Also bump version in test_metadata.py test.
Loading