Docs: add compatibility policy for Quantum ESPRESSO #737
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sphuber
added
the
pr/blocked
mbercx
approved these changes
Sep 21, 2021
README.md
Outdated
| | `v2.0.0 < v3.0.0` | <img class="svg-badge" title="Compatible with aiida-core >=0.12,<1.0.0" src="https://img.shields.io/badge/AiiDA->=0.12,<1.0.0-007ec6.svg?logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAACMAAAAhCAYAAABTERJSAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAFhgAABYYBG6Yz4AAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAUbSURBVFiFzZhrbFRVEMd%2Fc%2B5uu6UUbIFC%2FUAUVEQCLbQJBIiBDyiImJiIhmohYNCkqJAQxASLF8tDgYRHBLXRhIcKNtFEhVDgAxBJqgmVh4JEKg3EIn2QYqBlt917xg%2BFss%2ByaDHOtzsz5z%2B%2FuZl7ztmF%2F5HJvxVQN6cPYX8%2FPLnOmsvNAvqfwuib%2FbNIk9cQeQnLcKRL5xLIV%2Fic9eJeunjPYbRs4FjQSpTB3aS1IpRKeeOOewajy%2FKKEO8Q0DuVdKy8IqsbPulxGHUfCBBu%2BwUYGuFuBTK7wQnht6PEbf4tlRomVRjCbXNjQEB0AyrFQOL5ENIJm7dTLZE6DPJCnEtFZVXDLny%2B4Sjv0PmmYu1ZdUek9RiMgoDmJ8V0L7XJqsZ3UW8YsBOwEeHeeFce7jEYXBy0m9m4BbXqSj2%2Bxnkg26MCVrN6DEZcwggtd8pTFx%2Fh3B9B50YLaFOPwXQKUt0tBLegtSomfBlfY13PwijbEnhztGzgJsK5h9W9qeWwBqjvyhB2iBs1Qz0AU974DciRGO8CVN8AJhAeMAdA3KbrKEtvxhsI%2B9emWiJlGBEU680Cfk%2BSsVqXZvcFYGXjF8ABVJ%2BTNfVXehyms1zzn1gmIOxLEB6E31%2FWBe5rnCarmo7elf7dJEeaLh80GasliI5F6Q9cAz1GY1OJVNDxTzQTw7iY%2FHEZRQY7xqJ9RU2LFe%2FYqakdP911ha0XhjjiTVAkDwgatWfCGeYocx8M3glG8g8EXhSrLrHnEFJ5Ymow%2FkhIYv6ttYUW1iFmEqqxdVoUs9FmsDYSqmtmJh3Cl1%2BVtl2s7owDUdocR5bceiyoSivGTT5vzpbzL1uoBpmcAAQgW7ArnKD9ng9rc%2BNgrobSNwpSkkhcRN%2BvmXLjIsDovYHHEfmsYFygPAnIDEQrQPzJYCOaLHLUfIt7Oq0LJn9fxkSgNCb1qEIQ5UKgT%2Fs6gJmVOOroJhQBXVqw118QtWLdyUxEP45sUpSzqP7RDdFYMyB9UReMiF1MzPwoUqHt8hjGFFeP5wZAbZ%2F0%2BcAtAAcji6LeSq%2FMYiAvSsdw3GtrfVSVFUBbIhwRWYR7yOcr%2FBi%2FB1MSJZ16JlgH1AGM3EO2QnmMyrSbTSiACgFBv4yCUapZkt9qwWVL7aeOyHvArJjm8%2Fz9BhdI4XcZgz2%2FvRALosjsk1ODOyMcJn9%2FYI6IrkS5vxMGdUwou2YKfyVqJpn5t9aNs3gbQMbdbkxnGdsr4bTHm2AxWo9yNZK4PXR3uzhAh%2BM0AZejnCrGdy0UvJxl0oMKgWSLR%2B1LH2aE9ViejiFs%2BXn6bTjng3MlIhJ1I1TkuLdg6OcAbD7Xx%2Bc3y9TrWAiSHqVkbZ2v9ilCo6s4AjwZCzFyD9mOL305nV9aonvsQeT2L0gVk4OwOJqXXVRW7naaxswDKVdlYLyMXAnntteYmws2xcVVZzq%2BtHPAooQggmJkc6TLSusOiL4RKgwzzYU1iFQgiUBA1H7E8yPau%2BZl9P7AblVNebtHqTgxLfRqrNvZWjsHZFuqMqKcDWdlFjF7UGvX8Jn24DyEAykJwNcdg0OvJ4p5pQ9tV6SMlP4A0PNh8aYze1ArROyUNTNouy8tNF3Rt0CSXb6bRFl4%2FIfQzNMjaE9WwpYOWQnOdEF%2BTdJNO0iFh7%2BI0kfORzQZb6P2kymS9oTxzBiM9rUqLWr1WE5G6ODhycQd%2FUnNVeMbcH68hYkGycNoUNWc8fxaxfwhDbHpfwM5oeTY7rUX8QAAAABJRU5ErkJggg%3D%3D"> | [](https://pypi.python.org/pypi/aiida-quantumespresso/2.1.0/) | | ||
| | Plugin | AiiDA | Python | Quantum ESPRESSO | | ||
| |-|-|-|-| | ||
| | `v3.4.0 < v4.0.0` | <img class="svg-badge" title="Compatible with aiida-core >=1.4.4,<2.0.0" src="https://img.shields.io/badge/AiiDA->=1.4.4,<2.0.0-007ec6.svg?logo=[aiida-logo-base64]"> | [](https://pypi.org/project/aiida-quantumespresso.svg) | 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7 | |
There was a problem hiding this comment.
Except ... it doesn't work. Referencing only works with actual links, not variable substitution. Seeing if I can still make it work somehow
There was a problem hiding this comment.
I will remove this change from this PR and do it in a separate one.
README.md
Outdated
| | `v3.0.0 < v3.1.0` | <img class="svg-badge" title="Compatible with aiida-core >=1.0.0,<1.1.0" src="https://img.shields.io/badge/AiiDA->=1.0.0,<1.1.0-007ec6.svg?logo=[aiida-logo-base64]"> | [](https://pypi.org/project/aiida-quantumespresso/3.0.0/) | 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7 | | ||
| | `v2.0.0 < v3.0.0` | <img class="svg-badge" title="Compatible with aiida-core >=0.12,<1.0.0" src="https://img.shields.io/badge/AiiDA->=0.12,<1.0.0-007ec6.svg?logo=[aiida-logo-base64]"> | [](https://pypi.python.org/pypi/aiida-quantumespresso/2.1.0/) | 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7 | | ||
|
|
||
| Starting from `aiida-quantumespresso==4.0`, the last three minor versions of Quantum ESPRESSO are supported up to a maximum of two years. |
There was a problem hiding this comment.
This might be interpreted differently than what we discussed in #736. Perhaps:
Suggested change
| Starting from `aiida-quantumespresso==4.0`, the last three minor versions of Quantum ESPRESSO are supported up to a maximum of two years. | |
| Starting from `aiida-quantumespresso==4.0`, the last three minor versions of Quantum ESPRESSO are supported. Older versions are supported up to a maximum of two years. |
There was a problem hiding this comment.
I may have misunderstood what we discussed then. I thought even the last three minor versions would be subject to the 2 years max rule. For example, even if the oldest supported minor version happens to be 10 years old, do we still support it? Maybe it doesn't matter. And with what I propose, I guess we could technically end up with no supported versions, if the most recent version is older than two years 😅 but in that case there might be bigger problems at hand.
sphuber
removed
the
pr/blocked
Added the current compatibility to the matrix in the README.md together with the new explicit policy. Section is added to the documentation that links the README.md.
sphuber
force-pushed
the
fix/736/docs-support-policy
branch
from
a61a713
to
7e7880d
Compare
bastonero
pushed a commit
to bastonero/aiida-quantumespresso
that referenced
this pull request
Dec 20, 2021
Added the current compatibility to the matrix in the README.md together with the new explicit policy. Section is added to the documentation that links the README.md.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #736
Added the current compatibility to the matrix in the README.md together
with the new explicit policy. Section is added to the documentation that
links the README.md.