Skip to content

Commit

Permalink
Remove/update obsolete documentation about CI
Browse files Browse the repository at this point in the history
  • Loading branch information
yrodiere authored and marko-bekhta committed Dec 16, 2024
1 parent 53b9d21 commit 155f61f
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 57 deletions.
9 changes: 2 additions & 7 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
# SPDX-License-Identifier: Apache-2.0
# Copyright Red Hat Inc. and Hibernate Authors

# The main CI of Hibernate Search is https://ci.hibernate.org/job/hibernate-search/.
# However, Hibernate Search builds run on GitHub actions regularly
# to build on Windows
# and check that both the Linux and Windows workflows still work
# and can be used in GitHub forks.
# See https://docs.github.com/en/actions
# for more information about GitHub actions.
# This is not the main CI job, but it is useful on forks.
# See MAINTAINERS.md for details about all available CI jobs.

name: GH Actions CI

Expand Down
48 changes: 1 addition & 47 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -481,54 +481,8 @@ The Neo4j web UI will be accessible from http://localhost:7474/.

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

Continuous integration happens on a self-hosted Jenkins instance at https://ci.hibernate.org.
See [MAINTAINERS.md](MAINTAINERS.md#ci) for information about CI.

Several multi-branch pipelines are available.

### Main pipeline

https://ci.hibernate.org/job/hibernate-search/

See [Jenkinsfile](Jenkinsfile).

This job takes care of:

* Primary branch builds
* Pull request builds

It executes the build in a default environment, at the very least.
For primary branches, it may also re-execute the same build in different environments:

* Newer JDKs
* Different database vendors (PostgreSQL, Oracle, ...)
* Different versions of Elasticsearch/OpenSearch
* AWS Elasticsearch/OpenSearch Service

See [this section](#building-from-source) for information on how to execute similar builds from the commandline.

The job can be triggered manually, which is particularly useful to test more environments on a pull request.
### Release pipeline

https://ci.hibernate.org/job/hibernate-search/

See [Jenkinsfile](Jenkinsfile).

This job takes care of:

* Primary branch builds
* Pull request builds

It executes the build in a default environment, at the very least.
For primary branches, it may also re-execute the same build in different environments:

* Newer JDKs
* Different database vendors (PostgreSQL, Oracle, ...)
* Different versions of Elasticsearch/OpenSearch
* AWS Elasticsearch/OpenSearch Service

See [this section](#building-from-source) for information on how to execute similar builds from the commandline.

The job can be triggered manually, which is particularly useful to test more environments on a pull request.
## More conventions

### Naming and architecture rules
Expand Down
16 changes: 13 additions & 3 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ i.e. anybody with direct push access to the git repository.

See [CONTRIBUTING.md](CONTRIBUTING.md).

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

Continuous integration happens on a self-hosted Jenkins instance at https://ci.hibernate.org.
Continuous integration happens on a self-hosted Jenkins instance at https://ci.hibernate.org,
and to a smaller extent on GitHub Actions.

Several multi-branch pipelines are available.
Below is a list of all notable workflows/jobs.

### Main pipeline

Expand Down Expand Up @@ -40,6 +41,15 @@ For primary branches, it may also re-execute the same build in different environ
See [CONTRIBUTING.md](CONTRIBUTING.md#building-from-source)
for information about how to execute similar builds from the commandline.

### GitHub Actions workflow

A GitHub Actions workflow is set up, mainly to build/test on Windows,
and to help contributors build Hibernate Search from their own GitHub fork.

See [.github/workflows](.github/workflows) for the workflow definition.

See https://docs.github.com/en/actions for more information about GitHub actions.

### Snapshot publishing pipeline

https://ci.hibernate.org/job/hibernate-search-publish-snapshot/
Expand Down

0 comments on commit 155f61f

Please sign in to comment.