Skip to content

Commit 87bb686

Browse files
committed
Merge branch 'main' of https://github.com/bastonero/aiida-vibroscopy into feat/cli
2 parents 360863e + 835266a commit 87bb686

File tree

9 files changed

+208
-12
lines changed

9 files changed

+208
-12
lines changed

.cla/version1/CLA.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Contributor License Agreement
2+
3+
> Adapted from the [Apache Software Foundation Individual Contributor License Agreement (ICLA)](https://www.apache.org/licenses/contributor-agreements.html) [version 2.2](https://www.apache.org/licenses/icla.pdf)
4+
5+
You accept and agree to the following terms and conditions for Your
6+
Contributions (present and future) that you submit to the copyright
7+
holders (hereafter "HOLDERS", see the [`LICENSE.txt`](../../LICENSE.txt)
8+
bundled with this software). In return, the HOLDERS shall not use
9+
Your Contributions in a way that is contrary to the public benefit or
10+
inconsistent with its nonprofit status and bylaws in effect at the
11+
time of the Contribution. Except for the license granted herein to
12+
the HOLDERS and recipients of software distributed by the HOLDERS,
13+
You reserve all right, title, and interest in and to Your Contributions.
14+
15+
1. Definitions.
16+
17+
"You" (or "Your") shall mean the copyright owner or legal entity
18+
authorized by the copyright owner that is making this Agreement
19+
with the HOLDERS. For legal entities, the entity making a
20+
Contribution and all other entities that control, are controlled
21+
by, or are under common control with that entity are considered to
22+
be a single Contributor. For the purposes of this definition,
23+
"control" means (i) the power, direct or indirect, to cause the
24+
direction or management of such entity, whether by contract or
25+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
26+
outstanding shares, or (iii) beneficial ownership of such entity.
27+
"Contribution" shall mean any original work of authorship,
28+
including any modifications or additions to an existing work, that
29+
is intentionally submitted by You to the HOLDERS for inclusion
30+
in, or documentation of, any of the products owned or managed by
31+
the HOLDERS (the "Work"). For the purposes of this definition,
32+
"submitted" means any form of electronic, verbal, or written
33+
communication sent to the HOLDERS or its representatives,
34+
including but not limited to communication on electronic mailing
35+
lists, source code control systems, and issue tracking systems that
36+
are managed by, or on behalf of, the HOLDERS for the purpose of
37+
discussing and improving the Work, but excluding communication that
38+
is conspicuously marked or otherwise designated in writing by You
39+
as "Not a Contribution."
40+
41+
2. Grant of Copyright License. Subject to the terms and conditions of
42+
this Agreement, You hereby grant to the HOLDERS and to
43+
recipients of software distributed by the HOLDERS a perpetual,
44+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
45+
copyright license to reproduce, prepare derivative works of,
46+
publicly display, publicly perform, sublicense, and distribute Your
47+
Contributions and such derivative works.
48+
49+
3. Grant of Patent License. Subject to the terms and conditions of
50+
this Agreement, You hereby grant to the HOLDERS and to
51+
recipients of software distributed by the HOLDERS a perpetual,
52+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
53+
(except as stated in this section) patent license to make, have
54+
made, use, offer to sell, sell, import, and otherwise transfer the
55+
Work, where such license applies only to those patent claims
56+
licensable by You that are necessarily infringed by Your
57+
Contribution(s) alone or by combination of Your Contribution(s)
58+
with the Work to which such Contribution(s) was submitted. If any
59+
entity institutes patent litigation against You or any other entity
60+
(including a cross-claim or counterclaim in a lawsuit) alleging
61+
that your Contribution, or the Work to which you have contributed,
62+
constitutes direct or contributory patent infringement, then any
63+
patent licenses granted to that entity under this Agreement for
64+
that Contribution or Work shall terminate as of the date such
65+
litigation is filed.
66+
67+
4. You represent that you are legally entitled to grant the above
68+
license. If your employer(s) has rights to intellectual property
69+
that you create that includes your Contributions, you represent
70+
that you have received permission to make Contributions on behalf
71+
of that employer, that your employer has waived such rights for
72+
your Contributions to the HOLDERS, or that your employer has
73+
executed a separate Corporate CLA with the HOLDERS.
74+
75+
5. You represent that each of Your Contributions is Your original
76+
creation (see section 7 for submissions on behalf of others). You
77+
represent that Your Contribution submissions include complete
78+
details of any third-party license or other restriction (including,
79+
but not limited to, related patents and trademarks) of which you
80+
are personally aware and which are associated with any part of Your
81+
Contributions.
82+
83+
6. You are not expected to provide support for Your Contributions,
84+
except to the extent You desire to provide support. You may provide
85+
support for free, for a fee, or not at all. Unless required by
86+
applicable law or agreed to in writing, You provide Your
87+
Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
88+
OF ANY KIND, either express or implied, including, without
89+
limitation, any warranties or conditions of TITLE, NON-
90+
INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
91+
92+
7. Should You wish to submit work that is not Your original creation,
93+
You may submit it to the HOLDERS separately from any
94+
Contribution, identifying the complete details of its source and of
95+
any license or other restriction (including, but not limited to,
96+
related patents, trademarks, and license agreements) of which you
97+
are personally aware, and conspicuously marking the work as
98+
"Submitted on behalf of a third-party: [named here]".
99+
100+
8. You agree to notify the HOLDERS of any facts or circumstances of
101+
which you become aware that would make these representations
102+
inaccurate in any respect.

.cla/version1/signatures.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"signedContributors": [
3+
{
4+
"name": "bastonero",
5+
"id": 79980269,
6+
"comment_id": 2343829130,
7+
"created_at": "2024-09-11T14:22:56Z",
8+
"repoId": 390674389,
9+
"pullRequestNo": 78
10+
}
11+
]
12+
}

.clabot

Lines changed: 0 additions & 3 deletions
This file was deleted.

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jobs:
3737

3838
strategy:
3939
matrix:
40-
python-version: ['3.10']
40+
python-version: ['3.10','3.12']
4141

4242
services:
4343
rabbitmq:
@@ -75,6 +75,6 @@ jobs:
7575
uses: codecov/codecov-action@v3
7676
with:
7777
token: ${{ secrets.CODECOV_TOKEN }}
78-
name: pytests-vibroscopy3.9
78+
name: pytests-vibroscopy3.10
7979
flags: pytests
8080
fail_ci_if_error: true

.github/workflows/cla.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: "CLA Assistant"
2+
on:
3+
issue_comment:
4+
types: [created]
5+
pull_request_target:
6+
types: [opened, closed, synchronize]
7+
8+
# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
9+
permissions:
10+
actions: write
11+
contents: write
12+
pull-requests: write
13+
statuses: write
14+
15+
jobs:
16+
CLAAssistant:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/create-github-app-token@v1
20+
id: app-token
21+
with:
22+
app-id: ${{ vars.APP_ID }}
23+
private-key: ${{ secrets.PRIVATE_KEY }}
24+
25+
- uses: contributor-assistant/[email protected]
26+
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby accept the CLA') || github.event_name == 'pull_request_target'
27+
env:
28+
# the default github token does not allow github action to create & push commit,
29+
# instead, we need to use a github app to generate a token
30+
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
31+
GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
32+
# the below token should have repo scope and must be manually added by you in the repository's secret
33+
# This token is required only if you have configured to store the signatures in a remote repository/organization
34+
# PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
35+
with:
36+
path-to-signatures: ".cla/version1/signatures.json"
37+
path-to-document: "https://github.com/bastonero/aiida-vibroscopy/blob/main/.cla/version1/CLA.md"
38+
# branch should not be protected
39+
branch: "main"
40+
allowlist: bot*
41+
42+
# the followings are the optional inputs - If the optional inputs are not given, then default values will be taken
43+
#remote-organization-name: enter the remote organization name where the signatures should be stored (Default is storing the signatures in the same repository)
44+
#remote-repository-name: enter the remote repository name where the signatures should be stored (Default is storing the signatures in the same repository)
45+
#create-file-commit-message: 'For example: Creating file for storing CLA Signatures'
46+
#signed-commit-message: 'For example: $contributorName has signed the CLA in $owner/$repo#$pullRequestNo'
47+
custom-notsigned-prcomment: 'Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you accept our [Contributor License Agreement](https://github.com/bastonero/aiida-vibroscopy/blob/main/.cla/version1/CLA.md) before we can merge your contribution. You can accept the CLA by just copying the sentence below and posting it as a Pull Request Comment.'
48+
custom-pr-sign-comment: 'I have read the CLA Document and I hereby accept the CLA'
49+
custom-allsigned-prcomment: |
50+
All contributors have accepted the CLA ✅
51+
52+
---
53+
<sub>You might need to click the "Update/Rebase branch" button to update the pull request and rerun the GitHub actions to pass the CLA check.</sub>
54+
#lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true)
55+
#use-dco-flag: true - If you are using DCO instead of CLA

.github/workflows/update_changelog.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def update_changelog():
4040
print('🔍 Checking the current version number')
4141
current_changelog = Path('CHANGELOG.md').read_text(encoding='utf-8')
4242

43-
from aiida_quantumespresso import __version__
43+
from aiida_vibroscopy import __version__
4444

4545
if str(__version__) in current_changelog:
4646
print('🛑 Current version already in `CHANGELOG.md`. Skipping...')

CHANGELOG.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
1+
## v1.1.1
2+
3+
This minor release adds the new AiiDA contributor license agreement (CLA), and its GitHub bot,
4+
along with some dependency contraints for phonopy. The latest versions of phonopy (>v2.26)
5+
break the tests. While figuring out why, we patch this until a solution is found.
6+
7+
### 🐛 Bug fixes
8+
9+
* Deps: constrain phonopy and spglib versions [[3a3e3d1](https://github.com/aiidateam/aiida-quantumespresso/commit/3a3e3d117e34c6a66fcdc74e1e21c6263c203565)]
10+
11+
### 📚 Documentation
12+
13+
* Fix some docstrings and reports [[3ee9e7c](https://github.com/aiidateam/aiida-quantumespresso/commit/3ee9e7cbd2f5e6b8f15229dafbed58ae7ef4fa0d)]
14+
* Update main paper reference[[504c1b7](https://github.com/aiidateam/aiida-quantumespresso/commit/504c1b7b65a8852395d0ff3ec7271cb8c05c6931)]
15+
16+
### 🔧 Maintenance
17+
18+
* CLA: update and remove old cla-bot [[32bd829](https://github.com/aiidateam/aiida-quantumespresso/commit/32bd829987751deba056b7bfa739f6c82cf89d3e)]
19+
* @bastonero has signed the CLA in bastonero/aiida-vibroscopy#78[[e83739f](https://github.com/aiidateam/aiida-quantumespresso/commit/e83739f6aaecfcb304f8cac3da6d54b93f0fafb7)]
20+
* Add the AiiDA CLA [[df2cade](https://github.com/aiidateam/aiida-quantumespresso/commit/df2cade1bf200b8a2dd7004a48e40b118257f134)]
21+
* Add CLA bot [[3ba3e9e](https://github.com/aiidateam/aiida-quantumespresso/commit/3ba3e9e9f094106254b1a8ee4c97b85e66b41f85)]
22+
23+
### ⬆️ Update dependencies
24+
25+
* Deps: constrain phonopy and spglib versions [[3a3e3d1](https://github.com/aiidateam/aiida-quantumespresso/commit/3a3e3d117e34c6a66fcdc74e1e21c6263c203565)]
26+
27+
28+
29+
130
## v1.1.0
231

332
This minor release includes new post-processing utilities, a small breaking change in [[42503f3]](https://github.com/bastonero/aiida-vibroscopy/commit/42503f312d9a812cfc46d4c4a03a78641201e1d3) with regards to reference system for non-analytical and polarization directions. Some examples providing

pyproject.toml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,16 @@ classifiers = [
2121
'Programming Language :: Python :: 3.9',
2222
'Programming Language :: Python :: 3.10',
2323
'Programming Language :: Python :: 3.11',
24+
'Programming Language :: Python :: 3.12',
2425
]
2526
keywords = ['aiida', 'workflows']
2627
requires-python = '>=3.8'
2728
dependencies = [
28-
'aiida-core>=2.2.2,<3.0.0',
29-
'aiida-quantumespresso>=4.3.0',
30-
'aiida-phonopy>=1.1.3',
31-
'phonopy>=2.19.0,<3.0.0',
32-
'click~=8.0'
29+
"aiida-core>=2.2.2,<3.0.0",
30+
"aiida-quantumespresso>=4.3.0",
31+
"aiida-phonopy>=1.1.3",
32+
"spglib<2.5",
33+
"phonopy>=2.19.0,<=2.25.0",
3334
]
3435

3536
[project.urls]

src/aiida_vibroscopy/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
# For further information on the license, see the LICENSE.txt file #
88
#################################################################################
99
"""AiiDA plugin for vibrational spectoscopy using Quantum ESPRESSO."""
10-
__version__ = '1.1.0'
10+
__version__ = '1.1.1'

0 commit comments

Comments
 (0)