Skip to content

Commit

Permalink
HSEARCH-5094 Document Develocity
Browse files Browse the repository at this point in the history
  • Loading branch information
yrodiere committed Feb 29, 2024
1 parent 5a05949 commit 58198c2
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
31 changes: 30 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -46,6 +46,35 @@ A maven wrapper script is provided at the root of the repository (`./mvnw`),
so you can use that and don't need to care about the required version of Maven
(it will be downloaded automatically).

### <a id="setup-develocity"></a> Develocity build cache and build scans

Hibernate Search relies on a [Develocity](https://gradle.com/develocity/) instance
at [https://ge.hibernate.org](https://ge.hibernate.org/scans?search.rootProjectNames=Hibernate%20Search)
to speed up its build through a build cache

By default, only [continuous integration](#ci) builds will write to the remote build cache or publish build scans.

Local builds of Hibernate Search will:

* write to a local build cache;
* read from both a local and a remote build cache to speed up builds;
* not write to the remote build cache;
* not publish any build scans.

To opt out from build caches for a particular build (e.g. to debug flaky tests),
pass `-Dno-build-cache` to Maven.

To publish build scans for your local builds,
[reach out to the team](https://hibernate.org/community/#contribute) to set up an account,
and once you have one, run this from the root of your local clone of Hibernate Search:

```shell
./mvnw gradle-enterprise:provision-access-key
```

To opt out from build scans for a particular build (e.g. when working on a security vulnerability),
pass `-Dscan=false` to Maven.

### <a id="setup-ide"></a> IDE

#### <a id="setup-ide-intellij-idea"></a> IntelliJ IDEA
Expand Down Expand Up @@ -445,7 +474,7 @@ provided that build had the `jqassistant` profile enabled:

The Neo4j web UI will be accessible from http://localhost:7474/.

## Continuous integration
## <a id="ci"></a> Continuous integration

Continuous integration happens on a self-hosted Jenkins instance at https://ci.hibernate.org.

Expand Down
1 change: 1 addition & 0 deletions README.md
Expand Up @@ -4,6 +4,7 @@
[![Build Status](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.hibernate.org%2Fjob%2Fhibernate-search%2Fjob%2Fmain%2F&style=for-the-badge)](https://ci.hibernate.org/job/hibernate-search/job/main)
[![Sonar Coverage](https://img.shields.io/sonar/coverage/org.hibernate.search:hibernate-search-parent?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge)](https://sonarcloud.io/project/activity?id=org.hibernate.search%3Ahibernate-search-parent&graph=coverage)
[![Quality gate](https://img.shields.io/sonar/alert_status/org.hibernate.search:hibernate-search-parent?logo=sonarcloud&server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge)](https://sonarcloud.io/dashboard?id=org.hibernate.search%3Ahibernate-search-parent)
[![Develocity](https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?style=for-the-badge&logo=gradle)](https://ge.hibernate.org/scans?search.rootProjectNames=Hibernate%20Search)

## Description

Expand Down

0 comments on commit 58198c2

Please sign in to comment.