Skip to content

Commit

Permalink
Add build workflow, readme and make_release
Browse files Browse the repository at this point in the history
  • Loading branch information
matsbov committed Oct 2, 2023
1 parent 5039a4a commit bc301b0
Show file tree
Hide file tree
Showing 3 changed files with 130 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Build

on:
push:
branches:
- '*'
tags:
- '*'

jobs:

build:

runs-on: ubuntu-latest
steps:
- name: Checkout project sources
uses: actions/checkout@v3

- name: Setup Java
uses: actions/setup-java@v3
with:
java-version: '11'
distribution: 'temurin'

- name: Setup Gradle
uses: gradle/gradle-build-action@v2

- name: Run build with Gradle Wrapper
run: ./gradlew build -x integrationTest

- name: Upload war
uses: actions/upload-artifact@v3
with:
name: package
path: build/libs

- name: Log in to the Container registry
if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
uses: docker/login-action@v2
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

- name: Extract metadata (tags, labels) for Docker
if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
id: meta
uses: docker/metadata-action@v4
with:
images: ghcr.io/${{ github.repository }}

- name: Build and push Docker image
if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
uses: docker/build-push-action@v4
with:
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
38 changes: 38 additions & 0 deletions sbdi/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Spatial-service

## Setup

### Config and data directory
Create data directory at `/data/spatial-service` and populate as below (it is easiest to symlink the config files to the ones in this repo):
```
mats@xps-13:/data/spatial-service$ tree
.
└── config
└── spatial-service-config.yml -> /home/mats/src/biodiversitydata-se/spatial-service/sbdi/data/config/spatial-service-config.yml
```

You'll also need to create a directory named `/data/spatial-data`.


### Database
An empty database will be created the first time the application starts. You can then export the database from production and import it.

## Usage
Run locally:
```
make run
```

Build and run in Docker (using Tomcat). This requires a small change in the config file to work. See comment in Makefile.
```
make run-docker
```

Make a release. This will create a new tag and push it. A new Docker container will be built on Github.
```
mats@xps-13:~/src/biodiversitydata-se/spatial-service (master *)$ make release
Current version: 1.0.1. Enter the new version (or press Enter for 1.0.2):
Updating to version 1.0.2
Tag 1.0.2 created and pushed.
```
33 changes: 33 additions & 0 deletions sbdi/make-release.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
#!/bin/bash

# Get the last GitHub tag version
last_tag=$(git describe --tags --abbrev=0)

major=$(echo "$last_tag" | cut -d. -f1)
minor=$(echo "$last_tag" | cut -d. -f2)
patch=$(echo "$last_tag" | cut -d. -f3)

new_patch=$((patch + 1))

echo
read -p "Current version: $last_tag. Enter the new version (or press Enter for $major.$minor.$new_patch): " new_version_input

if [ -z "$new_version_input" ]; then
new_version="$major.$minor.$new_patch"
else
new_version="$new_version_input"
fi

# Validate the new version format (assuming it follows semantic versioning)
if ! [[ "$new_version" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
echo "Invalid version format. Please use semantic versioning (e.g., 1.2.3)."
exit 1
fi

echo "Updating to version $new_version"

# Create a new tag
git tag "$new_version"
git push origin "$new_version"

echo "Tag $new_version created and pushed."

0 comments on commit bc301b0

Please sign in to comment.