Russtopia
/
bacillus
mirror of http://gogs.blitter.com:3000/Russtopia/bacillus.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated README.md with lastRunDuration endpoint

This commit is contained in:
Russ Magee 2023-08-06 19:19:06 -07:00
parent 48a92284e8
commit de95bdedb9
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -1,6 +1,6 @@
MAKEOPTS = $(MAKEOPTS)
GIT_COMMIT := $(shell git rev-list -1 HEAD)
VERSION := 0.2.9.4-dev
VERSION := 0.2.9.4
BUILDOPTS :=$(BUILDOPTS) -ldflags "-X main.version=$(VERSION) -X main.gitCommit=$(GIT_COMMIT)"
.PHONY: install all clean

5
README.md
View File

@ -159,8 +159,9 @@ Some projects may wish to show the status of the most recent build on their own
status update about a build job. As of v0.2.9.3, two new endpoints may be referenced in order to see the build status of a job:
```
.../jobName/lastStatus # returns Content-type: text/plain, "lastStatus:n" (where n=0 for success, otherwise error)
.../jobName/lastStatusIcon # returns Content-type: image/jpeg (by default, a 32x32 JPEG) indicating success (0) or failure
.../jobName/lastStatus # returns Content-type: text/plain, "n" (where n=0 for success, otherwise error)
.../jobName/lastStatusIcon # returns Content-type: image/jpeg (by default, a 32x32 JPEG) indicating success (0) or failure
.../jobName/lastRunDuration # returns Content-type: text/plain, "str" (where str=duration as a string. eg. 1.4s)
```
The `lastStatusIcon` endpoint sends an HTTP Header `Cache-Control: no-cache` with the sent image, in order to aid clients querying the endpoint in displaying the most up-to-date CI status icon for the job; however initial testing indicates one might still need to force a refresh of one's webpage view to see the updated icon. Try an auto-refresh web extension which is capable of doing automated 'hard' refreshes (ignoring the browser cache) such as [Auto Refresh Plus for Chrome](https://chrome.google.com/webstore/detail/auto-refresh-plus-page-mo/hgeljhfekpckiiplhkigfehkdpldcggm). If you have control over your monitoring client, add a random URL parameter to the endpoint, eg. `.../jobName/lastStatusIcon?234034508` to defeat browser cacheing.