Merge branch 'koppor:main' into main

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,10 +1,5 @@
-<!-- 
-Describe the changes you have made here: what, why, ... 
-Link the issue that will be closed, e.g., "Closes #333".
-If your PR closes a koppor issue, link it using its URL, e.g., "Closes https://github.com/koppor/jabref/issues/47".
-"Closes" is a keyword GitHub uses to link PRs with issues; do not change it.
-Don't reference an issue in the PR title because GitHub does not support auto-linking there.
--->
+Describe the changes you have made here: what, why, ...
+Link the issue that will be closed, e.g., "Closes #333". If your PR closes a koppor issue, link it using its URL, e.g., "Closes https://github.com/koppor/jabref/issues/47".
 
 ### Mandatory checks
 

.github/workflows/assign-issue.yml

@@ -10,25 +10,47 @@ on:
 jobs:
   assign:
     runs-on: ubuntu-latest
+    permissions:
+      issues: write
     steps:
       - name: Assign the user or unassign stale assignments
-        uses: takanome-dev/[email protected]
+        id: assign
+        uses: takanome-dev/assign-issue-action@beta
         with:
           github_token: '${{ secrets.GITHUB_TOKEN }}'
           days_until_unassign: 30
+          maintainers: koppor, Siedlerchr, ThiloteE, calixtus, HoussemNasri
           assigned_comment: |
-            👋 Hey @{{ comment.user.login }},
+            👋 Hey @{{ handle }}, thank you for your interest in this issue! 🎉
 
-            Thanks for your interest in this issue! 🎉
-
-            Newcomers, we're excited to have you on board. Start by exploring our [Contributing](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md) guidelines, and don't forget to check out our [workspace setup guidelines](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace) to get started smoothly.
+            We're excited to have you on board. Start by exploring our [Contributing](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md) guidelines, and don't forget to check out our [workspace setup guidelines](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace) to get started smoothly.
 
             In case you encounter failing tests during development, please check our [developer FAQs](https://devdocs.jabref.org/code-howtos/faq.html)!
 
             Having any questions or issues? Feel free to ask here on GitHub. Need help setting up your local workspace? Join the conversation on [JabRef's Gitter chat](https://gitter.im/JabRef/jabref). And don't hesitate to open a (draft) pull request early on to show the direction it is heading towards. This way, you will receive valuable feedback.
 
-            ⚠ Note that this issue will become unassigned if it isn't closed within **{{ totalDays }} days**.
-
-            🔧 A maintainer can also add the **{{ inputs.pin_label }}** label to prevent it from being unassigned automatically.
-
             Happy coding! 🚀
+
+            ⏳ Please note, you will be automatically unassigned if the issue isn't closed within **{{ total_days }} days** (by **{{ unassigned_date }}**). A maintainer can also add the "**{{ pin_label }}**"" label to prevent automatic unassignment.
+      - name: Move Issue to "Assigned" Column in "Candidates for University Projects"
+        if: steps.assign.outputs.assigned == 'yes'
+        uses: m7kvqbe1/github-action-move-issues@feat/skip-if-not-in-project-flag
+        with:
+          github-token: ${{ secrets.GH_TOKEN_ACTION_MOVE_ISSUE }}
+          project-url: "https://github.com/orgs/JabRef/projects/3"
+          target-labels: "📍 Assigned"
+          target-column: "Assigned"
+          ignored-columns: ""
+          default-column: "Free to take"
+          skip-if-not-in-project: true
+      - name: Move Issue to "Assigned" Column in "Good First Issues"
+        if: steps.assign.outputs.assigned == 'yes'
+        uses: m7kvqbe1/github-action-move-issues@feat/skip-if-not-in-project-flag
+        with:
+          github-token: ${{ secrets.GH_TOKEN_ACTION_MOVE_ISSUE }}
+          project-url: "https://github.com/orgs/JabRef/projects/5"
+          target-labels: "📍 Assigned"
+          target-column: "Assigned"
+          ignored-columns: ""
+          default-column: "Free to take"
+          skip-if-not-in-project: true

.github/workflows/automerge.yml

@@ -10,13 +10,13 @@ jobs:
     runs-on: ubuntu-latest
     # Run only if PR is inside JabRef's main repository and created by dependabot or by an update workflow
     if: >
-      (github.repository == 'JabRef/jabref') && 
+      (github.repository == 'JabRef/jabref') &&
       (github.event.pull_request.head.repo.full_name == 'JabRef/jabref') &&
       (
         (github.actor == 'dependabot[bot]') ||
         (
-          startsWith(github.event.pull_request.title, '[Bot] ') || 
-          startsWith(github.event.pull_request.title, 'Bump ') || 
+          startsWith(github.event.pull_request.title, '[Bot] ') ||
+          startsWith(github.event.pull_request.title, 'Bump ') ||
           startsWith(github.event.pull_request.title, 'New Crowdin updates') ||
           startsWith(github.event.pull_request.title, 'Update Gradle Wrapper from')
         )
@@ -26,9 +26,9 @@ jobs:
         run: gh pr review --approve "$PR_URL"
         env:
           PR_URL: ${{github.event.pull_request.html_url}}
-          GITHUB_TOKEN: ${{secrets.GH_TOKEN_JABREF_MACHINE_PR_APPROVE}}
+          GH_TOKEN: ${{secrets.GH_TOKEN_JABREF_MACHINE_PR_APPROVE}}
       - name: Merge PR
         run: gh pr merge --auto --squash "$PR_URL"
         env:
           PR_URL: ${{github.event.pull_request.html_url}}
-          GITHUB_TOKEN: ${{secrets.GH_TOKEN_UPDATE_GRADLE_WRAPPER}}
+          GH_TOKEN: ${{secrets.GH_TOKEN_UPDATE_GRADLE_WRAPPER}}

.github/workflows/cleanup-pr.yml

@@ -39,6 +39,6 @@ jobs:
         if: steps.checksecrets.outputs.secretspresent == 'YES'
         uses: thollander/actions-comment-pull-request@v3
         with:
-          comment_tag: download-link
+          comment-tag: download-link
           message: The build for this PR is no longer available. Please visit <https://builds.jabref.org/main/> for the latest build.
           mode: upsert

.github/workflows/deployment.yml

@@ -291,7 +291,7 @@ jobs:
         with:
           message: |
             The build of this PR is available at <https://builds.jabref.org/pull/${{ github.event.pull_request.number }}/merge>.
-          comment_tag: download-link
+          comment-tag: download-link
           mode: recreate
   notarize: # outsourced in a separate job to be able to rerun if this fails for timeouts
     name: macOS notarization

.github/workflows/on-labeled-issue.yml

@@ -31,44 +31,25 @@ jobs:
 
           Happy coding! 🚀
     - name: Move Issue to "Assigned" Column in "Candidates for University Projects"
-      uses: m7kvqbe1/github-action-move-issues@v1.1.1
+      uses: m7kvqbe1/github-action-move-issues@feat/skip-if-not-in-project-flag
       with:
-       github-token: ${{ secrets.GH_TOKEN_ACTION_MOVE_ISSUE }}
-       project-url: "https://github.com/orgs/JabRef/projects/3"
-       target-labels: "FirstTimeCodeContribution"
-       target-column: "Assigned"
-       ignored-columns: ""
+        github-token: ${{ secrets.GH_TOKEN_ACTION_MOVE_ISSUE }}
+        project-url: "https://github.com/orgs/JabRef/projects/3"
+        target-labels: "📍 Assigned"
+        target-column: "Assigned"
+        ignored-columns: ""
+        default-column: "Free to take"
+        skip-if-not-in-project: true
     - name: Move Issue to "Assigned" Column in "Good First Issues"
-      uses: m7kvqbe1/github-action-move-issues@v1.1.1
+      uses: m7kvqbe1/github-action-move-issues@feat/skip-if-not-in-project-flag
       with:
-       github-token: ${{ secrets.GH_TOKEN_ACTION_MOVE_ISSUE }}
-       project-url: "https://github.com/orgs/JabRef/projects/5"
-       target-labels: "FirstTimeCodeContribution"
-       target-column: "Assigned"
-       ignored-columns: ""
-  Assigned:
-    name: "📍 Assigned"
-    if: ${{ github.event.label.name == '📍 Assigned' }}
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-    steps:
-    - name: Move Issue to "Assigned" Column in "Candidates for University Projects"
-      uses: m7kvqbe1/[email protected]
-      with:
-       github-token: ${{ secrets.GH_TOKEN_ACTION_MOVE_ISSUE }}
-       project-url: "https://github.com/orgs/JabRef/projects/3"
-       target-labels: "📍 Assigned"
-       target-column: "Assigned"
-       ignored-columns: ""
-    - name: Move Issue to "Assigned" Column in "Good First Issues"
-      uses: m7kvqbe1/[email protected]
-      with:
-       github-token: ${{ secrets.GH_TOKEN_ACTION_MOVE_ISSUE }}
-       project-url: "https://github.com/orgs/JabRef/projects/5"
-       target-labels: "📍 Assigned"
-       target-column: "Assigned"
-       ignored-columns: ""
+        github-token: ${{ secrets.GH_TOKEN_ACTION_MOVE_ISSUE }}
+        project-url: "https://github.com/orgs/JabRef/projects/5"
+        target-labels: "📍 Assigned"
+        target-column: "Assigned"
+        ignored-columns: ""
+        default-column: "Free to take"
+        skip-if-not-in-project: true
   good-first-issue:
     name: "good first issue"
     if: "${{ github.event.label.name == 'good first issue' }}"

.github/workflows/on-review-submitted.yml

@@ -0,0 +1,17 @@
+name: On reviewed PR
+
+on:
+  pull_request_review:
+     types:
+       - submitted
+
+jobs:
+  add-label-changes-required:
+    runs-on: ubuntu-latest
+    steps:
+      - run: |
+          gh pr edit "$PR_URL" --remove-label "status: ready-for-review"
+          gh pr edit "$PR_URL" --add-label "status: changes required"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GH_TOKEN: ${{secrets.GH_TOKEN_UPDATE_GRADLE_WRAPPER}}

.github/workflows/on-unlabeled-issue.yml

@@ -13,20 +13,22 @@ jobs:
       issues: write
     steps:
     - name: Move Issue to "Free to take" Column in "Candidates for University Projects"
-      uses: m7kvqbe1/github-action-move-issues@v1.1.1
+      uses: m7kvqbe1/github-action-move-issues@feat/skip-if-not-in-project-flag
       with:
-       github-token: ${{ secrets.GH_TOKEN_ACTION_MOVE_ISSUE }}
-       project-url: "https://github.com/orgs/JabRef/projects/3"
-       target-labels: "📍 Assigned"
-       target-column: "Assigned"
-       ignored-columns: ""
-       default-column: "Free to take"
+        github-token: ${{ secrets.GH_TOKEN_ACTION_MOVE_ISSUE }}
+        project-url: "https://github.com/orgs/JabRef/projects/3"
+        target-labels: "📍 Assigned"
+        target-column: "Assigned"
+        ignored-columns: ""
+        default-column: "Free to take"
+        skip-if-not-in-project: true
     - name: Move Issue to "Free to take" Column in "Good First Issues"
-      uses: m7kvqbe1/github-action-move-issues@v1.1.1
+      uses: m7kvqbe1/github-action-move-issues@feat/skip-if-not-in-project-flag
       with:
-       github-token: ${{ secrets.GH_TOKEN_ACTION_MOVE_ISSUE }}
-       project-url: "https://github.com/orgs/JabRef/projects/5"
-       target-labels: "📍 Assigned"
-       target-column: "Assigned"
-       ignored-columns: ""
-       default-column: "Free to take"
+        github-token: ${{ secrets.GH_TOKEN_ACTION_MOVE_ISSUE }}
+        project-url: "https://github.com/orgs/JabRef/projects/5"
+        target-labels: "📍 Assigned"
+        target-column: "Assigned"
+        ignored-columns: ""
+        default-column: "Free to take"
+        skip-if-not-in-project: true

docs/decisions/0000-use-markdown-any-decision-records.md → docs/decisions/0000-use-markdown-architectural-decision-records.md

@@ -2,27 +2,28 @@
 parent: Decision Records
 nav_order: 0
 ---
-# Use Markdown Any Decision Records
+# Use Markdown Architectural Decision Records
 
 ## Context and Problem Statement
 
-We want to record any decisions made in this project independent whether decisions concern the architecture ("architectural decision record"), the code, or other fields.
+We want to record architectural decisions made in this project independent whether decisions concern the architecture ("architectural decision record"), the code, or other fields.
 Which format and structure should these records follow?
 
 ## Considered Options
 
+* [MADR](https://adr.github.io/madr/) 4.0.0 – The Markdown Architectural Decision Records
 * [Michael Nygard's template](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) – The first incarnation of the term "ADR"
 * [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions) – The Y-Statements
 * Other templates listed at <https://github.com/joelparkerhenderson/architecture_decision_record>
 * Formless – No conventions for file format and structure
 
 ## Decision Outcome
 
-Chosen option: "MADR", because
+Chosen option: "MADR 4.0.0", because
 
 * Implicit assumptions should be made explicit.
   Design documentation is important to enable people understanding the decisions later on.
-  See also [A rational design process: How and why to fake it](https://doi.org/10.1109/TSE.1986.6312940).
+  See also ["A rational design process: How and why to fake it"](https://doi.org/10.1109/TSE.1986.6312940).
 * MADR allows for structured capturing of any decision.
 * The MADR format is lean and fits our development style.
 * The MADR structure is comprehensible and facilitates usage & maintenance.

docs/decisions/0006-only-translated-strings-in-language-file.md

@@ -22,7 +22,7 @@ JabRef has translation files `JabRef_it.properties`, ... There are translated an
 
 ## Decision Outcome
 
-Chosen option: "Only translated strings in language file", because comes out best \(see below.
+Chosen option: "Only translated strings in language file", because comes out best (see below).
 
 ## Pros and Cons of the Options
 

docs/decisions/0007-human-readable-changelog.md

@@ -6,7 +6,7 @@ nav_order: 7
 
 ## Context and Problem Statement
 
-Changes of a release have to be communicated. How and which stile to use?
+Changes of a release have to be communicated. How and which style to use?
 
 ## Considered Options
 

docs/decisions/0019-implement-special-fields-as-separate-fields.md

@@ -17,7 +17,7 @@ How to implement special fields in BibTeX databases?
 
 ## Decision Outcome
 
-Chosen option: "Special fields as separate fields", because comes out best (see below)
+Chosen option: "Special fields as separate fields", because comes out best (see below).
 
 ## Pros and Cons of the Options
 

docs/decisions/0020-use-Jackson-to-parse-study-yml.md

@@ -20,7 +20,7 @@ What parser should be used to parse YAML files?
 
 ## Decision Outcome
 
-Chosen option: Jackson, because as it is a dedicated library for parsing YAML. `yamlbeans` also seem to be viable. They all offer similar functionality.
+Chosen option: "Jackson", because as it is a dedicated library for parsing YAML. `yamlbeans` also seem to be viable. They all offer similar functionality.
 
 ## Pros and Cons of the Options
 

docs/decisions/0036-use-textarea-for-chat-content.md

@@ -25,7 +25,7 @@ This decision record concerns the UI component that is used for rendering the co
 
 ## Decision Outcome
 
-Chosen option: "Use TextArea".
+Chosen option: "Use `TextArea`".
 All other options require more time to implement.
 Some of the options do not support text selection and copying,
 which for now we value more than Markdown rendering.

docs/decisions/adr-template.md

@@ -9,16 +9,16 @@ nav_order: 100
 # Keep this
 parent: Decision Records
 
-# These are optional elements. Feel free to remove any of them.
-# status: {proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)}
-# date: {YYYY-MM-DD when the decision was last updated}
-# deciders: {list everyone involved in the decision}
-# consulted: {list everyone whose opinions are sought (typically subject-matter experts); and with whom there is a two-way communication}
-# informed: {list everyone who is kept up-to-date on progress; and with whom there is a one-way communication}
+# These are optional metadata elements. Feel free to remove any of them.
+status: "{proposed | rejected | accepted | deprecated | … | superseded by ADR-0123"
+date: {YYYY-MM-DD when the decision was last updated}
+decision-makers: {list everyone involved in the decision}
+consulted: {list everyone whose opinions are sought (typically subject-matter experts); and with whom there is a two-way communication}
+informed: {list everyone who is kept up-to-date on progress; and with whom there is a one-way communication}
 ---
 <!-- we need to disable MD025, because we use the different heading "ADR Template" in the homepage (see above) than it is foreseen in the template -->
 <!-- markdownlint-disable-next-line MD025 -->
-# {short title of solved problem and solution}
+# {short title, representative of solved problem and found solution}
 
 ## Context and Problem Statement
 
@@ -41,25 +41,19 @@ parent: Decision Records
 
 ## Decision Outcome
 
-Chosen option: "{title of option 1}", because
-{justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
+Chosen option: "{title of option 1}", because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
 
 <!-- This is an optional element. Feel free to remove. -->
-### Positive Consequences
+### Consequences
 
-* {e.g., improvement of one or more desired qualities, …}
-* …
-
-<!-- This is an optional element. Feel free to remove. -->
-### Negative Consequences
-
-* {e.g., compromising one or more desired qualities, …}
-* …
+* Good, because {positive consequence, e.g., improvement of one or more desired qualities, …}
+* Bad, because {negative consequence, e.g., compromising one or more desired qualities, …}
+* … <!-- numbers of consequences can vary -->
 
 <!-- This is an optional element. Feel free to remove. -->
-## Validation
+### Confirmation
 
-{describe how the implementation of/compliance with the ADR is validated. E.g., by a review or an ArchUnit test}
+{Describe how the implementation of/compliance with the ADR can/will be confirmed. Is the chosen design and its implementation in line with the decision? E.g., a design/code review or a test with a library such as ArchUnit can help validate this. Note that although we classify this element as optional, it is included in many ADRs.}
 
 <!-- This is an optional element. Feel free to remove. -->
 ## Pros and Cons of the Options
@@ -89,8 +83,4 @@ Chosen option: "{title of option 1}", because
 <!-- This is an optional element. Feel free to remove. -->
 ## More Information
 
-{You might want to provide additional evidence/confidence for the decision outcome here and/or
- document the team agreement on the decision and/or
- define when this decision when and how the decision should be realized and if/when it should be re-visited and/or
- how the decision is validated.
- Links to other decisions and resources might here appear as well.}
+{You might want to provide additional evidence/confidence for the decision outcome here and/or document the team agreement on the decision and/or define when/how this decision the decision should be realized and if/when it should be re-visited. Links to other decisions and resources might appear here as well.}

docs/decisions/index.md

@@ -4,7 +4,7 @@ has_children: true
 ---
 # Decision Records
 
-Below, all "any decision records" for JabRef are listed.
+Below, all "architectural decision records" for JabRef are listed.
 This list uses the TOC functionality of the [Just the Docs Jekyll template](https://just-the-docs.github.io/just-the-docs/).
 
 For new ADRs, please use [adr-template.md](adr-template.md) as basis.