Skip to content

Commit

Permalink
Merge pull request #108 from cicirello/remove-jitpack
Browse files Browse the repository at this point in the history
Removed support for importing from JitPack
  • Loading branch information
cicirello authored Oct 1, 2023
2 parents c80314d + 8333862 commit 7703793
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 86 deletions.
21 changes: 0 additions & 21 deletions .github/workflows/jitpack-build.yml

This file was deleted.

6 changes: 0 additions & 6 deletions .github/workflows/maven-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,3 @@ jobs:
gh release upload ${TAG} target/${{ env.artifact_name }}-${{ steps.get_version.outputs.VERSION }}-javadoc.jar
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Request release from JitPack to trigger build
run: |
JITPACK_URL="https://jitpack.io/org/cicirello/ZigguratGaussian/${{ steps.get_version.outputs.VERSION }}/maven-metadata.xml"
# timeout in 30 seconds to avoid waiting for build
curl -s -m 30 ${JITPACK_URL} || true
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased] - 2023-08-07
## [Unreleased] - 2023-10-01

### Added

Expand All @@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Deprecated

### Removed
* Removed support for importing from JitPack.

### Fixed

Expand Down
55 changes: 6 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Copyright (C) 2015, 2017-2023 [Vincent A. Cicirello](https://www.cicirello.org/).

| __Packages and Releases__ | [![Maven Central](https://img.shields.io/maven-central/v/org.cicirello/ziggurat.svg?label=Maven%20Central&logo=apachemaven)](https://central.sonatype.com/artifact/org.cicirello/ziggurat/) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/cicirello/ZigguratGaussian?logo=GitHub)](https://github.com/cicirello/ZigguratGaussian/releases) [![JitPack](https://jitpack.io/v/org.cicirello/ZigguratGaussian.svg)](https://jitpack.io/#org.cicirello/ZigguratGaussian) |
| __Packages and Releases__ | [![Maven Central](https://img.shields.io/maven-central/v/org.cicirello/ziggurat.svg?label=Maven%20Central&logo=apachemaven)](https://central.sonatype.com/artifact/org.cicirello/ziggurat/) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/cicirello/ZigguratGaussian?logo=GitHub)](https://github.com/cicirello/ZigguratGaussian/releases) |
| :--- | :--- |
| __Build Status__ | [![build](https://github.com/cicirello/ZigguratGaussian/workflows/build/badge.svg)](https://github.com/cicirello/ZigguratGaussian/actions/workflows/build.yml) [![CodeQL](https://github.com/cicirello/ZigguratGaussian/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/cicirello/ZigguratGaussian/actions/workflows/codeql-analysis.yml) |
| __JaCoCo Test Coverage__ | [![coverage](https://raw.githubusercontent.com/cicirello/ZigguratGaussian/badges/jacoco.svg)](https://github.com/cicirello/ZigguratGaussian/actions/workflows/build.yml) [![branches coverage](https://raw.githubusercontent.com/cicirello/ZigguratGaussian/badges/branches.svg)](https://github.com/cicirello/ZigguratGaussian/actions/workflows/build.yml) |
Expand Down Expand Up @@ -65,16 +65,14 @@ and PATCH corresponds to backwards compatible bug fixes.

## Java 11+

The jars of the library, distributed via Maven Central, JitPack, GitHub Packages, and GitHub Releases, are
built with OpenJDK 17 but for a target of Java 11.
The jars of the library, distributed via Maven Central, GitHub Packages,
and GitHub Releases, are built with OpenJDK 17 but for a target of Java 11.

## Importing from Package Repositories

Prebuilt artifacts are regularly published to Maven Central, GitHub Packages, and JitPack. In most
cases, you'll want to use Maven Central. JitPack may be useful if you want to build your project against
the latest unreleased version, essentially against the default branch of the repository, or a specific commit.
Releases are published to JitPack and GitHub Packages mainly as a fall-back in the unlikely scenario that
Maven Central is unavailable.
Prebuilt artifacts are regularly published to Maven Central and GitHub Packages. In
most cases, you'll want to use Maven Central. Releases are published to GitHub
Packages mainly as a fall-back in the unlikely scenario that Maven Central is unavailable.

### Importing from Maven Central

Expand Down Expand Up @@ -105,47 +103,6 @@ the following to the repositories section of your pom.xml:

Note that GitHub Packages requires authenticating to GitHub.

### Importing from JitPack

You can also import from JitPack. As above, you need to first add JitPack to
the repositories section of your pom.xml, such as:

```XML
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
```

JitPack works a bit differently than Maven Central. Specifically, JitPack builds
artifacts on-demand from the GitHub repository the first time a version is requested. We have
configured our domain on JitPack for the groupId, but on JitPack you use the GitHub repository
name as the artifactId. In many cases this may be the same as the Maven Central artifactId, but
this is not the case here. The Maven Central artifactId is `ziggurat`, but the repository name
is `ZigguratGaussian`. Therefore, from JitPack, you need the following dependency
(just replace `x.y.z` with the version that you want):

```XML
<dependency>
<groupId>org.cicirello</groupId>
<artifactId>ZigguratGaussian</artifactId>
<version>x.y.z</version>
</dependency>
```

We have primarily configured JitPack as a source of SNAPSHOT builds. If you want to build
your project against the latest commit, specify the dependency as:

```XML
<dependency>
<groupId>org.cicirello</groupId>
<artifactId>ZigguratGaussian</artifactId>
<version>master-SNAPSHOT</version>
</dependency>
```

You can also build against a specific commit using the commit hash as the version.

### Downloading Jar Files

If you don't use a dependency manager that supports importing from Maven Central,
Expand Down
9 changes: 0 additions & 9 deletions jitpack.yml

This file was deleted.

0 comments on commit 7703793

Please sign in to comment.