Skip to content

Commit 577114b

Browse files
committed
Merge branch 'release/1.0.0'
2 parents f3e7da1 + 48a8362 commit 577114b

File tree

196 files changed

+13513
-1055
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

196 files changed

+13513
-1055
lines changed

.dockerignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
data
2+
target
3+
src

.editorconfig

+1,319-12
Large diffs are not rendered by default.

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -197,4 +197,4 @@ gradle-app.setting
197197
**/build/
198198

199199
# End of https://www.toptal.com/developers/gitignore/api/gradle
200-
application.yml
200+
/application.yml

Jenkinsfile JenkinsfileSCM

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
pipeline {
33
agent {
44
kubernetes {
5+
inheritFrom "default"
56
yamlFile 'kubernetesPod.yaml'
7+
yamlMergeStrategy merge()
68
}
79
}
810

@@ -17,7 +19,7 @@ pipeline {
1719

1820
configFileProvider([configFile(fileId: 'maven-settings-rsb', variable: 'MAVEN_SETTINGS_RSB')]) {
1921

20-
sh 'mvn -B -s $MAVEN_SETTINGS_RSB -U clean install deploy -DskipTests=true'
22+
sh 'mvn -B -s $MAVEN_SETTINGS_RSB -U clean install deploy'
2123

2224
}
2325

LICENSE_HEADER

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Crane
22

3-
Copyright (C) 2021-2022 Open Analytics
3+
Copyright (C) 2021-2025 Open Analytics
44

55
===========================================================================
66

README.md

+28-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,32 @@
11
# Crane
22

3-
Crane is a small Spring Boot project used for hosting authenticated R
4-
Repositories. It is designed to be used in combination with RDepot. Because
5-
Crane combines the hosting of directories with authentication and authorization
6-
it can be used for many other use-cases, such as the hosting of documentation or
7-
project assets.
3+
Crane is a webserver with advanced Authentication and Authorization (using
4+
OpenID Connect) for hosting data science artifacts, documentation and much more!
85

9-
Learn more at https://crane.rdepot.io
6+
Learn more at <https://craneserver.net/>
107

11-
**(c) Copyright Open Analytics NV, 2021-2022 - Apache License 2.0**
8+
## Building from source
9+
10+
Clone this repository and run
11+
12+
```bash
13+
mvn -U clean install
14+
```
15+
16+
The build will result in a single `.jar` file: `target/crane-${CRANE_VERSION}-exec.jar` where crane
17+
18+
## Running
19+
20+
Crane can either be run locally or using the [docker image](https://hub.docker.com/r/openanalytics/crane).
21+
22+
To run crane locally the following command can be used:
23+
24+
```bash
25+
java -jar target/crane-${CRANE_VERSION}-exec.jar
26+
```
27+
28+
## Java Version
29+
30+
This project requires JDK 17.
31+
32+
**(c) Copyright Open Analytics NV, 2021-2025 - Apache License 2.0**

devbox.json

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/jetify-com/devbox/0.13.4/.schema/devbox.schema.json",
3+
"packages": [
4+
"vale@latest",
5+
"maven@latest",
6+
"jdk17@latest",
7+
"docker-compose@latest",
8+
"hugo@latest",
9+
"go@latest",
10+
"kustomize@latest",
11+
"kubectl@latest",
12+
"minikube@latest",
13+
"git@latest"
14+
],
15+
"shell": {
16+
"init_hook": [],
17+
"scripts": {
18+
"test": [
19+
"mvn clean test"
20+
],
21+
"build": [
22+
"mvn -B -s $MAVEN_SETTINGS_RSB -U clean install deploy"
23+
],
24+
"update-license": [
25+
"mvn license:format"
26+
],
27+
"minikube": [
28+
"minikube start --kubernetes-version='v1.31' --addons=metrics-server,ingress --container-runtime=containerd",
29+
"kustomize build docs/deployment/overlays/crane | kubectl apply -f - --server-side"
30+
]
31+
}
32+
}
33+
}

0 commit comments

Comments
 (0)