Skip to content

Commit cfafdea

Browse files
authored
Merge pull request #520 from metafacture/484-gradle8
Upgrade Gradle wrapper to version 8.6
2 parents 0b85363 + 3165f2e commit cfafdea

File tree

36 files changed

+822
-792
lines changed

36 files changed

+822
-792
lines changed

.editorconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ trim_trailing_whitespace = true
2828
end_of_line = crlf
2929
trim_trailing_whitespace = false
3030

31-
[*.{gradle,yml}]
31+
[*.{g,gradle,json,xml,xsd,yml}]
3232
indent_size = 2
3333

3434
[metafacture-io/src/test/resources/org/metafacture/io/compressed.txt]

.github/workflows/publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
with:
1313
java-version: 1.8
1414
- name: Publish package
15-
run: ./gradlew publish
15+
run: ./gradlew publishAllPublicationsToGitHubPackagesRepository
1616
env:
1717
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1818

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ tmp
3232
.classpath
3333
.project
3434
.settings/
35-
bin/
3635

3736
# Ignore IntelliJ project files:
3837
*.ipr

CONTRIBUTING.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -180,43 +180,43 @@ We use semantic versioning in release numbers `A`.`B`.`C`, i.e. increase `A` whe
180180
The following commands trigger a release build.
181181

182182
1. Create a signed tag:
183-
```
184-
git tag -s metafacture-core-A.B.C
185-
```
183+
```
184+
git tag -s metafacture-core-A.B.C
185+
```
186186
1. When prompted, add a sensible commit message. For instance, something like:
187-
```
188-
Publish first release of the Metafacture A line
189-
```
187+
```
188+
Publish first release of the Metafacture A line
189+
```
190190
1. You can now test the build locally by invoking:
191-
```
192-
./gradlew assemble
193-
```
191+
```
192+
./gradlew assemble
193+
```
194194
1. Finally, push the new tag to GitHub to trigger the actual release build:
195-
```
196-
git push --follow-tags metafacture-core-A.B.C
197-
```
195+
```
196+
git push --follow-tags metafacture-core-A.B.C
197+
```
198198
199199
#### Publish to Maven Central
200200
201201
Upload archives to sonatype (where they can be released to Maven Central)
202202
203203
1. Make sure to have a clean directory (otherwise only a SNAPSHOT will be built):
204-
```
205-
git status
206-
```
204+
```
205+
git status
206+
```
207207
1. You need a `gradle.properties` in the root directory that looks like this:
208-
```
209-
signing.gnupg.executable=gpg
210-
signing.gnupg.useLegacyGpg=true
211-
signing.gnupg.homeDir=$e.g."~/.gnupg"
212-
signing.gnupg.keyName=$yourKeyName
213-
signing.gnupg.passphrase=$keysPassphrase
214-
releaseRepositoryUrl=https://oss.sonatype.org/service/local/staging/deploy/maven2/
215-
releaseRepositoryUser=$yourSonatypeUsername
216-
releaseRepositoryPassword=$yourSonatypePassword
217-
```
208+
```
209+
signing.gnupg.executable=gpg
210+
signing.gnupg.useLegacyGpg=true
211+
signing.gnupg.homeDir=$e.g."~/.gnupg"
212+
signing.gnupg.keyName=$yourKeyName
213+
signing.gnupg.passphrase=$keysPassphrase
214+
releaseRepositoryUrl=https://oss.sonatype.org/service/local/staging/deploy/maven2/
215+
releaseRepositoryUser=$yourSonatypeUsername
216+
releaseRepositoryPassword=$yourSonatypePassword
217+
```
218218
1. Let the release be built, signed and uploaded:
219-
```
220-
./gradlew uploadArchives
221-
```
219+
```
220+
./gradlew publishAllPublicationsToMavenRepository
221+
```
222222
1. Finally, go to oss.sonatype.org , check the `Staging Repositories` when it's finished, and release it by clicking `close`

README.md

Lines changed: 41 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,32 @@ You can either use Metafacture as a stand-alone application or include it as a J
1717
## Metafacture as a stand-alone application
1818

1919
If you are only interested in running Flux scripts without doing any Java programming this is the way to go. The instructions assume that you are using a \*nix-like shell. [See more information in the wiki page about Flux](https://github.com/metafacture/metafacture-core/wiki/Flux-user-guide).
20+
You can `build` the stand-alone application yourself or `download` it.
2021

21-
1. Download the latest distribution package from the [release page](https://github.com/metafacture/metafacture-core/releases). Make sure that you do download a distribution package and *not* a source code package (the file name should include `*-dist*`).
22-
23-
2. Extract the downloaded archive:
24-
```bash
25-
$ tar xzf metafacture-core-$VERSION-dist.tar.gz
26-
```
27-
This will create a new directory containing a ready-to-use Metafacture distribution.
28-
3. Change into the newly created directory:
29-
```bash
30-
$ cd metafacture-core-$VERSION
31-
```
32-
4. Run one of the example scripts:
33-
```bash
34-
$ ./flux.sh examples/read/marc21/read-marc21.flux
35-
```
36-
This example will print a number of MARC 21 records on standard output.
22+
a) Build
23+
24+
Proceed as described in [Building metafacture-core from source](#build_from_source).
25+
26+
b) Download
27+
28+
Download the latest distribution package from the [release page](https://github.com/metafacture/metafacture-core/releases). Make sure that you do download a distribution package and *not* a source code package (the file name should include `*-dist*`).
29+
30+
Regardless if you've built or downloaded, go on with:
31+
32+
1. Extract the archive:
33+
```bash
34+
$ tar xzf metafacture-core-$VERSION-dist.tar.gz
35+
```
36+
This will create a new directory containing a ready-to-use Metafacture distribution.
37+
2. Change into the newly created directory:
38+
```bash
39+
$ cd metafacture-core-$VERSION
40+
```
41+
3. Run one of the example scripts:
42+
```bash
43+
$ ./flux.sh examples/read/marc21/read-marc21.flux
44+
```
45+
This example will print a number of MARC 21 records on standard output.
3746

3847
The `examples` folder contains many more examples which provide a good starting point for learning Metafacture. If you have any questions please join our [mailing list](http://lists.dnb.de/mailman/listinfo/metafacture) or use our issue-based discussion forum over at [metafacture-documentation](https://github.com/metafacture/metafacture-documentation).
3948

@@ -66,25 +75,27 @@ Occasionally, we publish snapshot builds on [Sonatype OSS Repository](https://os
6675
TODO: Link to getting started tutorial
6776
-->
6877

78+
79+
<a name="build_from_source"></a>
6980
# Building metafacture-core from source
7081

7182
Building metafacture-core from source is easy. All you need is git and JDK 8:
7283

7384
1. Clone the metafacture-core repository and change into the directory:
74-
75-
```bash
76-
$ git clone https://github.com/metafacture/metafacture-core.git
77-
$ cd metafacture-core
78-
```
79-
80-
2. Invoke the Gradle wrapper to download Gradle and build metafacture-core (on Windows call `gradlew.bat install` instead):
81-
82-
```bash
83-
$ ./gradlew install
84-
```
85-
86-
Besides the resulting distribution in `metafacture-core/metafacture-runner/build/distributions/` this also provides builds in your local maven repository.
87-
85+
```bash
86+
$ git clone https://github.com/metafacture/metafacture-core.git
87+
$ cd metafacture-core
88+
```
89+
90+
2. Invoke the Gradle wrapper to download Gradle and build metafacture-core (on Windows call `gradlew.bat publishToMavenLocal` instead) and publish these to your local Maven repository:
91+
```bash
92+
$ ./gradlew publishToMavenLocal
93+
```
94+
95+
3. Create a distribution if you need one. The resulting distribution can be found in `metafacture-core/metafacture-runner/build/distributions/`:
96+
```bash
97+
$ ./gradlew assembleDist
98+
```
8899

89100
See [Code Quality and Style](https://github.com/metafacture/metafacture-core/wiki/Code-Quality-and-Style) on the wiki for further information on the sources.
90101

0 commit comments

Comments
 (0)