Skip to content

Commit 155f61f

Browse files
yrodieremarko-bekhta
authored andcommitted
Remove/update obsolete documentation about CI
1 parent 53b9d21 commit 155f61f

File tree

3 files changed

+16
-57
lines changed

3 files changed

+16
-57
lines changed

.github/workflows/ci.yml

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
11
# SPDX-License-Identifier: Apache-2.0
22
# Copyright Red Hat Inc. and Hibernate Authors
33

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

127
name: GH Actions CI
138

CONTRIBUTING.md

Lines changed: 1 addition & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -481,54 +481,8 @@ The Neo4j web UI will be accessible from http://localhost:7474/.
481481

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

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

486-
Several multi-branch pipelines are available.
487-
488-
### Main pipeline
489-
490-
https://ci.hibernate.org/job/hibernate-search/
491-
492-
See [Jenkinsfile](Jenkinsfile).
493-
494-
This job takes care of:
495-
496-
* Primary branch builds
497-
* Pull request builds
498-
499-
It executes the build in a default environment, at the very least.
500-
For primary branches, it may also re-execute the same build in different environments:
501-
502-
* Newer JDKs
503-
* Different database vendors (PostgreSQL, Oracle, ...)
504-
* Different versions of Elasticsearch/OpenSearch
505-
* AWS Elasticsearch/OpenSearch Service
506-
507-
See [this section](#building-from-source) for information on how to execute similar builds from the commandline.
508-
509-
The job can be triggered manually, which is particularly useful to test more environments on a pull request.
510-
### Release pipeline
511-
512-
https://ci.hibernate.org/job/hibernate-search/
513-
514-
See [Jenkinsfile](Jenkinsfile).
515-
516-
This job takes care of:
517-
518-
* Primary branch builds
519-
* Pull request builds
520-
521-
It executes the build in a default environment, at the very least.
522-
For primary branches, it may also re-execute the same build in different environments:
523-
524-
* Newer JDKs
525-
* Different database vendors (PostgreSQL, Oracle, ...)
526-
* Different versions of Elasticsearch/OpenSearch
527-
* AWS Elasticsearch/OpenSearch Service
528-
529-
See [this section](#building-from-source) for information on how to execute similar builds from the commandline.
530-
531-
The job can be triggered manually, which is particularly useful to test more environments on a pull request.
532486
## More conventions
533487

534488
### Naming and architecture rules

MAINTAINERS.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ i.e. anybody with direct push access to the git repository.
88

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

11-
## Continuous integration
11+
## <a id="ci"></a> Continuous integration
1212

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

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

1718
### Main pipeline
1819

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

44+
### GitHub Actions workflow
45+
46+
A GitHub Actions workflow is set up, mainly to build/test on Windows,
47+
and to help contributors build Hibernate Search from their own GitHub fork.
48+
49+
See [.github/workflows](.github/workflows) for the workflow definition.
50+
51+
See https://docs.github.com/en/actions for more information about GitHub actions.
52+
4353
### Snapshot publishing pipeline
4454

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

0 commit comments

Comments
 (0)