Skip to content

Commit e3b52e0

Browse files
committed
Add automatic version change of readme examples; Update changelog
1 parent cb43b08 commit e3b52e0

2 files changed

Lines changed: 26 additions & 11 deletions

File tree

Makefile

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
VERSION := $(shell cat VERSION)
22

3-
.PHONY: all python java
3+
.PHONY: all python java readme
44

5-
all: clean python java
5+
all: clean python java readme
66

77
clean:
88
rm -f python/visionapi/visionapi/*pb2.py*
@@ -14,4 +14,8 @@ python:
1414

1515
java:
1616
protoc -I=. --java_out=java/visionapi/src/main/java/ visionapi/*.proto
17-
(cd java/visionapi && mvn versions:set -DgenerateBackupPoms=false -DnewVersion=$(VERSION))
17+
(cd java/visionapi && mvn versions:set -DgenerateBackupPoms=false -DnewVersion=$(VERSION))
18+
19+
readme:
20+
sed -E 's|tag = "[0-9\.]+"|tag = "$(VERSION)"|' -i Readme.md
21+
sed -E 's|<version>[0-9\.]+</version>|<version>$(VERSION)</version>|' -i Readme.md

Readme.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,20 @@
33
This repo contains the main data model for the Starwit Awareness Engine (SAE). See umbrella repo here: https://github.com/starwit/starwit-awareness-engine
44

55
## How-To Use
6+
7+
### Python / Poetry
8+
- Add the following to your `pyproject.toml` dependencies section\
9+
`visionapi = { git = "https://github.com/starwit/vision-api.git", subdirectory = "python/visionapi", tag = "3.2.0" }`
10+
611
### Java / Maven
12+
- Add dependency to your project:
13+
```xml
14+
<dependency>
15+
<groupId>de.starwit</groupId>
16+
<artifactId>vision-api</artifactId>
17+
<version>3.2.0</version>
18+
</dependency>
19+
```
720
- Add maven repository to your `~/.m2/settings.xml` (adapt example / your config as necessary):
821
```xml
922
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
@@ -44,20 +57,13 @@ This repo contains the main data model for the Starwit Awareness Engine (SAE). S
4457
</settings>
4558

4659
```
47-
- Add dependency to your project:
48-
```xml
49-
<dependency>
50-
<groupId>de.starwit</groupId>
51-
<artifactId>vision-api</artifactId>
52-
<version>3.1.0</version>
53-
</dependency>
54-
```
5560

5661
## How-To Update
5762
1. Make desired changes in `./visionapi`
5863
2. Increase version in `./VERSION`
5964
3. Run `make`
6065
4. Make sure that there are no old leftover files in the generated projects
66+
5. Describe change in changelog section below
6167
5. Commit, tag with version and push
6268
```
6369
// Commit stuff, like git add, git commit and such
@@ -71,6 +77,11 @@ ProtoBuf compiler can be downloaded here:
7177
https://github.com/protocolbuffers/protobuf/releases
7278

7379
## Changelog
80+
### 3.2.0
81+
- Add `source_id` to messages (to distinguish which source the messages are generated from)
82+
- Add `IncidentMessage.source_id`
83+
- Add `AnomalyMessage.source_id`
84+
7485
### 3.1.0
7586
- Add camera location field to all messages (as type `GeoCoordinate`)
7687
- Add `SaeMessage.frame.camera_location`

0 commit comments

Comments
 (0)