Skip to content

Commit

Permalink
Link to GitHub contributors in about dialog (#7319)
Browse files Browse the repository at this point in the history
Co-authored-by: Oliver Kopp <[email protected]>
  • Loading branch information
stefan-kolb and koppor authored Jan 11, 2021
1 parent 0a971fd commit 519bc3a
Show file tree
Hide file tree
Showing 14 changed files with 36 additions and 359 deletions.
3 changes: 0 additions & 3 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ gradlew text eol=lf
# windows line endings at windows files
*.bat text eol=crlf

# required for proper releasing
AUTHORS text eol=lf

# ensure that line endings of *.java, and *.properties are normalized
*.java text
*.properties text
Expand Down
32 changes: 0 additions & 32 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -232,35 +232,3 @@ jobs:
steps:
- uses: actions/checkout@v2
- uses: gradle/wrapper-validation-action@v1
checkauthors:
name: "Validate AUTHORS"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
# full checkout needed for authors generation
fetch-depth: 0
- name: "All authors of this PR listed in AUTHORS"
id: authors_check
shell: bash
run: |
git config user.name "JabRef Author Checker [bot]"
git config user.email "[email protected]"
./scripts/generate-authors.sh
set +o pipefail
added=$(git diff HEAD --no-ext-diff --unified=0 -a --no-prefix | egrep "^\+[^+]" | sed "s/^\+//")
if [ -z "$added" ]; then
echo "No authors added"
exit 0
fi
echo "Authors found in this PR not listed in the AUTHORS file."
echo
echo "The JabRef maintainers will add the following name to the AUTHORS file"
echo
echo -e "$added"
echo
echo "In case you want to use a different one, please comment here and adjust your name in your git configuration for future commits"
echo
echo "Just adding yourself into the AUTHORS file does not help as it is overwritten by our script ./scripts/generate-authors."
echo "Read more on the AUTHORS file at found at https://github.com/JabRef/jabref/blob/master/CONTRIBUTING.md#author-credits"
exit 1
217 changes: 0 additions & 217 deletions .mailmap

This file was deleted.

File renamed without changes.
3 changes: 1 addition & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -269,8 +269,7 @@ processResources {
filesMatching("build.properties") {
expand(version: project.findProperty('projVersionInfo') ?: '100.0.0',
"year": String.valueOf(Calendar.getInstance().get(Calendar.YEAR)),
"authors": new File('AUTHORS').readLines().findAll { !it.startsWith("#") }.join(", "),
"developers": new File('DEVELOPERS').readLines().findAll { !it.startsWith("#") }.join(", "),
"maintainers": new File('MAINTAINERS').readLines().findAll { !it.startsWith("#") }.join(", "),
"azureInstrumentationKey": System.getenv('AzureInstrumentationKey'),
"springerNatureAPIKey": System.getenv('SpringerNatureAPIKey'),
"astrophysicsDataSystemAPIKey": System.getenv('AstrophysicsDataSystemAPIKey'),
Expand Down
12 changes: 2 additions & 10 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,9 @@ In case you add keys to the changelog, please follow these rules:

#### Author credits

You will be given credit in the [`AUTHORS`](https://github.com/JabRef/jabref/blob/master/AUTHORS) file in the root of the repository and the 'About' pages inside the main application.
We will periodically update the contributors list inside `AUTHORS`.
This is done by an automatic shell script `scripts/generate-authors.sh`.

If you want to add yourself directly with your pull request please run this script.
Please make sure there are no duplicates or alternate spellings of your name listed.
If you need to merge different Git usernames or email addresses you can do so by editing `.mailmap`.
More information on this can be found via `man git-shortlog`.

Please, **do not add yourself at JavaDoc's `@authors`**.
The contribution information is tracked via the version control system.
The contribution information is tracked via the version control system and shown at <https://github.com/JabRef/jabref/graphs/contributors>.
We also link to the contributors page in our about dialog.

Your contribution is considered being made under [MIT license](https://tldrlegal.com/license/mit-license).

Expand Down
62 changes: 0 additions & 62 deletions scripts/generate-authors.sh

This file was deleted.

4 changes: 4 additions & 0 deletions src/main/java/org/jabref/gui/help/AboutDialog.css
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@
-fx-padding: 5px;
}

.contrib-section {
-fx-padding: 5 5 10 5;
}

.logo-pane {
fx-fill: transparent;
}
Expand Down
Loading

0 comments on commit 519bc3a

Please sign in to comment.