Skip to content

Commit d17a92c

Browse files
FlorianK13FlorianK13
authored
Merge pull request #538 from OpenEnergyPlatform/release-v0.14.4
Release v0.14.4
2 parents f18ecac + 4d54fd5 commit d17a92c

File tree

16 files changed

+239
-45
lines changed

16 files changed

+239
-45
lines changed

‎.bumpversion.cfg‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[bumpversion]
2-
current_version = 0.14.3
2+
current_version = 0.14.4
33
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)((?P<release>(a|na))+(?P<build>\d+))?
44
serialize =
55
{major}.{minor}.{patch}{release}{build}

‎.github/ISSUE_TEMPLATE/issue_template_user_kudos.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: User Kudos
3+
about: Share appreciation for the project!
4+
title: Add new user to USERS.cff
5+
labels: user
6+
assignees: ''
7+
8+
---
9+
10+
Thanks for supporting the project and helping to improve its recognition by joining USERS.cff.
11+
It helps the project quite a bit!
12+
13+
We will add you to the list of valued users.
14+
15+
Please, insert your information between the double quotes below - fill out at minimum "affiliation" :purple_heart:
16+
17+
family-names: ""
18+
given-names: ""
19+
alias: ""
20+
affiliation: ""
21+
orcid: ""
22+
23+
Thank you!

‎.github/workflows/ci-production.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
- name: create package
3333
run: python -m build --sdist
3434
- name: import open-mastr
35-
run: python -m pip install ./dist/open_mastr-0.14.3.tar.gz
35+
run: python -m pip install ./dist/open_mastr-0.14.4.tar.gz
3636
- name: Create credentials file
3737
env:
3838
MASTR_TOKEN: ${{ secrets.MASTR_TOKEN }}

‎.github/workflows/extend_user_cff.yml‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
name: create-pr-to-add-user-to-usercff
2+
3+
on:
4+
workflow_dispatch:
5+
issues:
6+
types: [opened, labeled]
7+
8+
permissions:
9+
contents: write
10+
pull-requests: write
11+
12+
jobs:
13+
create-pr-to-add-new-user:
14+
if: contains(join(github.event.issue.labels.*.name, ','), 'user')
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v4
20+
with:
21+
# checkout to develop branch of repo
22+
ref: develop
23+
24+
- name: Set up Node.js
25+
uses: actions/setup-node@v4
26+
with:
27+
node-version: '18'
28+
29+
- name: Extract issue details
30+
id: extract_details
31+
run: |
32+
echo "Extracting issue details..."
33+
ISSUE_BODY="${{ github.event.issue.body }}"
34+
echo "Issue body content:"
35+
echo "$ISSUE_BODY"
36+
37+
# Extract information
38+
FAMILY_NAMES=$(echo "$ISSUE_BODY" | grep '^family-names:' | sed 's/family-names: //')
39+
GIVEN_NAMES=$(echo "$ISSUE_BODY" | grep '^given-names:' | sed 's/given-names: //')
40+
ALIAS=$(echo "$ISSUE_BODY" | grep '^alias:' | sed 's/alias: //')
41+
AFFILIATION=$(echo "$ISSUE_BODY" | grep '^affiliation:' | sed 's/affiliation: //')
42+
ORCID=$(echo "$ISSUE_BODY" | grep '^orcid:' | sed 's/orcid: //')
43+
44+
# Delete new lines and add to env variables
45+
echo "FAMILY_NAMES=$(echo -n $FAMILY_NAMES | tr -d '\n')" >> $GITHUB_ENV
46+
echo "GIVEN_NAMES=$(echo -n $GIVEN_NAMES | tr -d '\n')" >> $GITHUB_ENV
47+
echo "ALIAS=$(echo -n $ALIAS | tr -d '\n')" >> $GITHUB_ENV
48+
echo "AFFILIATION=$(echo -n $AFFILIATION | tr -d '\n')" >> $GITHUB_ENV
49+
echo "ORCID=$(echo -n $ORCID | tr -d '\n')" >> $GITHUB_ENV
50+
51+
- name: Debug extracted values
52+
run: |
53+
echo "Family Names: ${{env.FAMILY_NAMES}}"
54+
echo "Given Names: ${{env.GIVEN_NAMES}}"
55+
echo "Alias: ${{env.ALIAS}}"
56+
echo "Affiliation: ${{env.AFFILIATION}}"
57+
echo "ORCID: ${{env.ORCID}}"
58+
59+
- name: Update USERS.cff
60+
run: |
61+
# double quotes are not added, due to formatting hell. Double quotes will cause the creation of additional unwanted new lines, even when checked out as \"
62+
tee -a USERS.cff <<EOF
63+
- family-names: ${{env.FAMILY_NAMES}}
64+
given-names: ${{env.GIVEN_NAMES}}
65+
alias: ${{env.ALIAS}}
66+
affiliation: ${{env.AFFILIATION}}
67+
orcid: ${{env.ORCID}}
68+
EOF
69+
70+
71+
- name: Print updated USERS.cff
72+
run: cat USERS.cff
73+
74+
- name: Create Pull Request
75+
uses: peter-evans/create-pull-request@v6
76+
with:
77+
base: develop
78+
head: workflow-${{ github.event.issue.number }}-update-users-cff
79+
branch: workflow-${{ github.event.issue.number }}-update-users-cff
80+
title: 'Update USERS.cff with new user information'
81+
commit-message: |
82+
Add new user to USERS.cff
83+
body: |
84+
This pull request updates the USERS.cff file with new user information extracted from issue #${{ github.event.issue.number }}
85+
86+
Closes #${{ github.event.issue.number }}
87+
88+
Many thanks ${{ github.actor }}!

‎CHANGELOG.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@ For each version important additions, changes and removals are listed here.
66
The format is inspired from [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
77
and the versioning aims to respect [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
88

9+
## [v0.14.4] Release for the Journal of Open Source Software JOSS - 2024-06-07
10+
### Added
11+
- Extend documentation section `getting started` based on the JOSS Review [#523](https://github.com/OpenEnergyPlatform/open-MaStR/pull/523)
12+
- Extend and repair documentation based on the JOSS Review [#527](https://github.com/OpenEnergyPlatform/open-MaStR/pull/527)
13+
- Add issue template and workflow to populate USERS.cff [#528](https://github.com/OpenEnergyPlatform/open-MaStR/pull/529)
14+
- Add imposter syndrom disclaimer to `CONTRIBUTING.md` [#537](https://github.com/OpenEnergyPlatform/open-MaStR/pull/537)
15+
### Changed
16+
- Change License identifier for pypi [#525](https://github.com/OpenEnergyPlatform/open-MaStR/pull/525)
17+
- Change header to identify as open-mastr during http request [#526](https://github.com/OpenEnergyPlatform/open-MaStR/pull/526)
18+
- Fixed missing call to gen_url in case first bulk download fails as xml file for today is not yet available [#534](https://github.com/OpenEnergyPlatform/open-MaStR/pull/534)
19+
- Repair links in the documentation page [#536](https://github.com/OpenEnergyPlatform/open-MaStR/pull/536)
20+
921

1022
## [v0.14.3] Fix Pypi Release - 2024-04-24
1123
### Added

‎CITATION.cff‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ authors:
2828
title: "open-MaStR"
2929
type: software
3030
license: AGPL-3.0
31-
version: 0.14.3
31+
version: 0.14.4
3232
doi:
33-
date-released: 2024-04-24
33+
date-released: 2024-06-07
3434
url: "https://github.com/OpenEnergyPlatform/open-MaStR/"

‎CONTRIBUTING.md‎

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,33 @@
33

44
# Collaborative Development
55

6+
## Impostor Syndrome Disclaimer
7+
8+
Before we get into the details: **We want your help. No, really.**
9+
10+
There may be a little voice inside your head that is telling you that you're
11+
not ready to be an open source contributor; that your skills aren't nearly good
12+
enough to contribute. What could you possibly offer a project like this one?
13+
14+
We assure you -- the little voice in your head is wrong. If you can write code
15+
at all, you can contribute code to open source. Contributing to open source
16+
projects is a fantastic way to advance one's coding skills. Writing perfect
17+
code isn't the measure of a good developer (that would disqualify all of us!);
18+
it's trying to create something, making mistakes, and learning from those
19+
mistakes. That's how we all improve.
20+
21+
We've provided some clear `Contribution Guidelines` that you can read below.
22+
The guidelines outline the process that you'll need to follow to get a patch
23+
merged. By making expectations and process explicit, we hope it will make it
24+
easier for you to contribute.
25+
26+
And you don't just have to write code. You can help out by writing
27+
documentation, tests, or even by giving feedback about this work. (And yes,
28+
that includes giving feedback about the contribution guidelines.)
29+
30+
([Adrienne Friend](https://github.com/adriennefriend/imposter-syndrome-disclaimer)
31+
came up with this disclaimer language.)
32+
633
## Prerequisites
734
- [Git](https://git-scm.com/)
835
- [GitHub](https://github.com/)
@@ -15,12 +42,11 @@ Please be self-reflective and always maintain a good culture of discussion and a
1542
Since the open license allows free use, no notification is required.
1643
However, for the authors it is valuable information who uses the software for what purpose.
1744
Indicators are `Watch`, `Fork` and `Starred` of the repository.
18-
If you are a user, please add your name and details in USERS.cff
45+
If you are a user, please add your name and details in [USERS.cff](https://github.com/OpenEnergyPlatform/open-MaStR/blob/production/USERS.cff) by using the [issue template](https://github.com/OpenEnergyPlatform/open-MaStR/issues/new?assignees=&labels=user&projects=&template=user-kudos.md&title=Add+new+user+to+USERS.cff).
1946

2047
### B. Comment
2148
You can give ideas, hints or report bugs in issues, in PR, at meetings or other channels.
2249
This is no development but can be considered a notable contribution.
23-
If you wish, add your name and details to `CITATION.cff`.
2450

2551
### C. Contribute and Review
2652
You add code and become an author of the repository.
@@ -114,6 +140,7 @@ git commit filename.md
114140
```
115141

116142
Write a good `commit message`:
143+
117144
- "If applied, this commit will ..."
118145
- Follow [existing conventions for commit messages](https://chris.beams.io/posts/git-commit)
119146
- Keep the subject line [shorter than 50 characters](https://chris.beams.io/posts/git-commit/#limit-50)
@@ -156,6 +183,7 @@ Follow the GitHub guide [approving a pull request with required reviews](https:/
156183
Assign one reviewer or a user group and get into contact.
157184

158185
If you are the reviewer:
186+
159187
- Check the changes in all corresponding files.
160188
- Checkout the branch and run code.
161189
- Comment if you would like to change something (Use `Request changes`)

‎README.rst‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ open-mastr
2020
* - Tests
2121
- |badge_ci|
2222
* - Publication
23-
- |badge_pypi|
23+
- |badge_pypi| |badge_joss|
2424
* - Data Publication
2525
- |badge_zenodo|
2626
* - Development
@@ -184,4 +184,7 @@ Data
184184
.. |Total PyPI downloads| image:: https://static.pepy.tech/badge/open-mastr
185185
:target: https://pepy.tech/project/open-mastr
186186

187+
.. |badge_joss| image:: https://joss.theoj.org/papers/dc0d33e7dc74f7233e15a7b6fe0c7a3e/status.svg
188+
:target: https://joss.theoj.org/papers/dc0d33e7dc74f7233e15a7b6fe0c7a3e
189+
187190

‎RELEASE_PROCEDURE.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,15 @@ It always has the format `YYYY-MM-DD`, e.g. `2022-05-16`.
5454
* Commit version update with `git commit -am "version update v0.12.1a1"`
5555
* Push branch with `git push --set-upstream origin release-v0.12.1`
5656

57-
### 6. Check release on Test-PyPI
57+
### 6. 📝 Update the version files
58+
* `📝CHANGELOG.md`
59+
* All Pull Request are included
60+
* Add a new section with correct version number
61+
* Give the suitable name to the release
62+
* `📝CITATION.cff`
63+
* Update `date-released`
64+
65+
### 7. Optional: Check release on Test-PyPI
5866

5967
* Check if the release it correctly displayed on [Test-PyPI](https://test.pypi.org/project/open-mastr/#history)
6068
* You can trigger the release manually within github actions using the `run workflow` button on branch `release-v0.12.1` on the workflow `Build and release on pypi tests`
@@ -64,14 +72,6 @@ It always has the format `YYYY-MM-DD`, e.g. `2022-05-16`.
6472
* Note: The release on Test-PyPI might fail, but it will be the correct release version for the PyPI server.
6573
* Push commits to the `release-*` branch
6674

67-
### 7. 📝 Update the version files
68-
* `📝CHANGELOG.md`
69-
* All Pull Request are included
70-
* Add a new section with correct version number
71-
* Give the suitable name to the release
72-
* `📝CITATION.cff`
73-
* Update `date-released`
74-
7575
### 8. 🐙 Create a `Release Pull Request`
7676
* Use `📝PR_TEMPLATE_RELEASE` (❗ToDo❗)
7777
* Merge `release` into `production` branch

‎USERS.cff‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please leave your name for reference.
3+
authors:
4+
- family-names:
5+
given-names:
6+
alias:
7+
affiliation: Reiner Lemoine Institut
8+
orcid:

0 commit comments

Comments
 (0)