GitHub actions workflows

.ci/get_version_from_git.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+TAG=$(git describe --tags --abbrev=0 2>/dev/null)
+SUFFIX=$(git show -s --format=%ct.%h HEAD)
+
+if [ -n "${TAG}" ]; then
+  COMMITS_SINCE_TAG=$(git rev-list ${TAG}.. --count)
+  if [ "${COMMITS_SINCE_TAG}" -gt 0 ]; then
+    SUFFIX="dev${COMMITS_SINCE_TAG}.${SUFFIX}"
+  fi
+else
+  TAG="0"
+fi
+
+echo "${TAG}+git.${SUFFIX}"

.github/workflows/dashboards-ci.yml

@@ -0,0 +1,51 @@
+name: Dashboards CI
+
+# this workflow will
+# - check for JSON syntax errors on every pull request
+# - commit to the OBS development upstream whenever master the master branch is updated
+
+on:
+  push:
+    paths:
+    - 'dashboards/**'
+    - 'packaging/obs/grafana-ha-cluster-dashboards/**'
+    - '.github/workflows/dashboards*'
+  pull_request:
+    paths:
+    - 'dashboards/**'
+    - 'packaging/obs/grafana-ha-cluster-dashboards/**'
+    - '.github/workflows/dashboards*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v1
+    - run: npm -g install jsonlint
+    - name: validate JSON
+      run: find dashboards -name "*.json" -type f -exec jsonlint -c {} \;
+
+  obs-commit:
+    needs: build
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    container: shap/continuous_deliver
+    env:
+      OBS_USER: ${{ secrets.OBS_USER }}
+      OBS_PASS: ${{ secrets.OBS_PASS }}
+      OBS_PROJECT: ${{ secrets.OBS_PROJECT }}
+      REVISION: ${{ github.sha }}
+      REPOSITORY: ${{ github.repository }}
+      GITHUB_OAUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: configure OSC
+      run: |
+        /scripts/init_osc_creds.sh
+        mkdir -p $HOME/.config/osc
+        cp /root/.config/osc/oscrc $HOME/.config/osc
+    - run: make dashboards-obs-commit
+

.github/workflows/exporter-ci.yml

@@ -0,0 +1,107 @@
+name: Exporter CI
+
+# this workflow will
+# - check build and test the go codebase on every pull request
+# - commit to the OBS development upstream whenever master the master branch is updated
+# - perform an OBS Submit Request to downstream whenever a GitHub release is published
+# - attach build artifacts to GitHub releases
+
+on:
+  push:
+    paths-ignore:
+    - 'dashboards/**'
+    - 'packaging/obs/grafana-ha-cluster-dashboards/**'
+    - '.github/workflows/dashboards*'
+  pull_request:
+    paths-ignore:
+    - 'dashboards/**'
+    - 'packaging/obs/grafana-ha-cluster-dashboards/**'
+    - '.github/workflows/dashboards*'
+  release:
+    types: [ published ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/setup-go@v2
+      with:
+        go-version: ^1.12
+      id: go
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: static analysis
+      run: make static-checks
+    - name: test
+      run: make test
+    - name: build
+      run: make -j4 build-all
+    - uses: actions/upload-artifact@v2
+      with:
+        name: ha_cluster_exporter
+        path: build/bin
+
+  obs-commit:
+    needs: build
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    container: shap/continuous_deliver
+    env:
+      OBS_USER: ${{ secrets.OBS_USER }}
+      OBS_PASS: ${{ secrets.OBS_PASS }}
+      OBS_PROJECT: ${{ secrets.OBS_PROJECT }}
+      REVISION: ${{ github.sha }}
+      REPOSITORY: ${{ github.repository }}
+      GITHUB_OAUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: configure OSC
+      run: |
+        /scripts/init_osc_creds.sh
+        mkdir -p $HOME/.config/osc
+        cp /root/.config/osc/oscrc $HOME/.config/osc
+    - run: make exporter-obs-commit
+
+  obs-submit-request:
+    needs: build
+    if: github.event.release
+    runs-on: ubuntu-latest
+    container: shap/continuous_deliver
+    env:
+      OBS_USER: ${{ secrets.OBS_USER }}
+      OBS_PASS: ${{ secrets.OBS_PASS }}
+      OBS_PROJECT: ${{ secrets.OBS_PROJECT }}
+      PACKAGE_NAME: prometheus-ha_cluster_exporter
+      TARGET_PROJECT: ${{ secrets.OBS_DOWNSTREAM_PROJECT }}
+      REVISION: ${{ github.event.release.tag_name }}
+      REPOSITORY: ${{ github.repository }}
+      GITHUB_OAUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: configure OSC
+      run: |
+        /scripts/init_osc_creds.sh
+        mkdir -p $HOME/.config/osc
+        cp /root/.config/osc/oscrc $HOME/.config/osc
+    - run: make exporter-obs-workdir
+    - run: make exporter-obs-changelog
+    - run: make exporter-obs-commit
+    - run: /scripts/submit.sh
+
+  github-release-assets:
+    needs: build
+    if: github.event.release
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/download-artifact@v2
+      with:
+        name: ha_cluster_exporter
+    - uses: AButler/upload-release-assets@v2.0
+      with:
+        files: 'ha_cluster_exporter-*'
+        repo-token: ${{ secrets.GITHUB_TOKEN }}

Makefile

@@ -1,8 +1,12 @@
-# this is the what ends up in the RPM "Version" field and it is also used as suffix for the built binaries
-# if you want to release to OBS it must be a remotely available Git reference
-VERSION ?= $(shell git describe --tags --abbrev=0)dev+git.$(shell git show -s --format=%ct.%h HEAD)
+# this is the what ends up in the RPM "Version" field and embedded in the --version CLI flag
+VERSION ?= $(shell .ci/get_version_from_git.sh)
+
+# this
 DATE = $(shell date --iso-8601=seconds)
 
+# if you want to release to OBS, this must be a remotely available Git reference
+REVISION ?= master
+
 # we only use this to comply with RPM changelog conventions at SUSE
 AUTHOR ?= shap-staff@suse.de
 
@@ -21,11 +25,11 @@ download:
 
 build: amd64
 
-build-all: clean-bin $(ARCHS)
+build-all: clean $(ARCHS)
 
 $(ARCHS):
 	@mkdir -p build/bin
-	CGO_ENABLED=0 GOOS=linux GOARCH=$@ go build -trimpath -ldflags "-s -w -X main.version=$(VERSION) -X main.buildDate=$(DATE)" -o build/bin/ha_cluster_exporter-$(VERSION)-$@
+	CGO_ENABLED=0 GOOS=linux GOARCH=$@ go build -trimpath -ldflags "-s -w -X main.version=$(VERSION) -X main.buildDate=$(DATE)" -o build/bin/ha_cluster_exporter-$@
 
 install:
 	go install
@@ -56,32 +60,33 @@ clean:
 	go clean
 	rm -rf build
 
-exporter-obs-workdir:
-	rm -rf build/obs/prometheus-ha_cluster_exporter
+exporter-obs-workdir: build/obs/prometheus-ha_cluster_exporter
+build/obs/prometheus-ha_cluster_exporter:
 	@mkdir -p build/obs/prometheus-ha_cluster_exporter
 	osc checkout $(OBS_PROJECT) prometheus-ha_cluster_exporter -o build/obs/prometheus-ha_cluster_exporter
 	rm -f build/obs/prometheus-ha_cluster_exporter/*.tar.gz
 	cp -rv packaging/obs/prometheus-ha_cluster_exporter/* build/obs/prometheus-ha_cluster_exporter/
 # we interpolate environment variables in OBS _service file so that we control what is downloaded by the tar_scm source service
 	sed -i 's~%%VERSION%%~$(VERSION)~' build/obs/prometheus-ha_cluster_exporter/_service
+	sed -i 's~%%REVISION%%~$(REVISION)~' build/obs/prometheus-ha_cluster_exporter/_service
 	sed -i 's~%%REPOSITORY%%~$(REPOSITORY)~' build/obs/prometheus-ha_cluster_exporter/_service
 	cd build/obs/prometheus-ha_cluster_exporter; osc service runall
 
 exporter-obs-changelog: exporter-obs-workdir
-	.ci/gh_release_to_obs_changeset.py $(REPOSITORY) -a $(AUTHOR) -t $(VERSION) -f build/obs/exporter/prometheus-ha_cluster_exporter.changes || true
+	.ci/gh_release_to_obs_changeset.py $(REPOSITORY) -a $(AUTHOR) -t $(REVISION) -f build/obs/prometheus-ha_cluster_exporter/prometheus-ha_cluster_exporter.changes
 
-exporter-obs-commit: exporter-obs-workdir exporter-obs-changelog
+exporter-obs-commit: exporter-obs-workdir
 	cd build/obs/prometheus-ha_cluster_exporter; osc addremove
 	cd build/obs/prometheus-ha_cluster_exporter; osc commit -m "Update to version $(VERSION)"
 
-dashboards-obs-workdir:
-	rm -rf build/obs/grafana-ha-cluster-dashboards
+dashboards-obs-workdir: build/obs/grafana-ha-cluster-dashboards
+build/obs/grafana-ha-cluster-dashboards:
 	@mkdir -p build/obs/grafana-ha-cluster-dashboards
 	osc checkout $(OBS_PROJECT) grafana-ha-cluster-dashboards -o build/obs/grafana-ha-cluster-dashboards
 	rm -f build/obs/grafana-ha-cluster-dashboards/*.tar.gz
 	cp -rv packaging/obs/grafana-ha-cluster-dashboards/* build/obs/grafana-ha-cluster-dashboards/
 # we interpolate environment variables in OBS _service file so that we control what is downloaded by the tar_scm source service
-	sed -i 's~%%VERSION%%~$(VERSION)~' build/obs/grafana-ha-cluster-dashboards/_service
+	sed -i 's~%%REVISION%%~$(REVISION)~' build/obs/grafana-ha-cluster-dashboards/_service
 	sed -i 's~%%REPOSITORY%%~$(REPOSITORY)~' build/obs/grafana-ha-cluster-dashboards/_service
 	cd build/obs/grafana-ha-cluster-dashboards; osc service runall
 

dashboards/README.md

@@ -29,7 +29,7 @@ zypper in grafana-ha-cluster-dashboards
 systemctl restart grafana-server
 ```
 
-For the latest development version, please refer to the [development upstream project in OBS](https://build.opensuse.org/project/show/network:ha-clustering:sap-deployments:devel). 
+For the latest development version, please refer to the [development upstream project in OBS](https://build.opensuse.org/project/show/network:ha-clustering:sap-deployments:devel), which is automatically updated everytime we merge changes in this repository. 
 
 ### Manual
 
@@ -39,5 +39,10 @@ Once done, restart the Grafana server.
 
 ### Grafana.com
 
-TO-DO
+Dashboards will be soon available on [grafana.com/dashboards](https://grafana.com/dashboards)
 
+## Development notes
+
+- Please make sure the `version` field in the JSON is incremented just once per PR.
+- Unlike the exporter, OBS Submit Requests are not automated for the dashboard package.  
+  Once PRs are merged, you will have to manually perform a Submit Request, after updating the `version` field in the `_service` file and adding an entry to the `grafana-ha-cluster-dashboards.changes` file.    

doc/development.md

@@ -17,7 +17,7 @@ You can also cross-compile to the various architectures we support with `make bu
 
 ## OBS Packaging
 
-The CI will automatically publish GitHub releases to SUSE's Open Build Service: to perform a new release, just publish a new GH release or push a git tag. Tags must always follow the [SemVer](https://semver.org/) scheme.
+The CI will automatically publish GitHub releases to SUSE's Open Build Service: to perform a new release, just publish a new GH release. Tags must always follow the [SemVer](https://semver.org/) scheme.
 
 If you wish to produce an OBS working directory locally, having configured [`osc`](https://en.opensuse.org/openSUSE:OSC) already, you can run:
 ```
@@ -27,14 +27,14 @@ This will checkout the OBS project and prepare a new OBS commit in the `build/ob
 
 Note that, by default, the current Git working directory HEAD reference is used to download the sources from the remote, so this reference must have been pushed beforehand.
 
-You can use the `OSB_PROJECT`, `REPOSITORY` and `VERSION` environment variables to change the behaviour of OBS-related make targets.
+You can use the `OSB_PROJECT`, `REPOSITORY` and `REVISION` environment variables to change the behaviour of OBS-related make targets.
 
 For example, if you were on a feature branch of your own fork, you may want to change these variables, so:
 ```bash
 git push feature/yxz # don't forget to make changes remotely available
 export OBS_PROJECT=home:JohnDoe
 export REPOSITORY=johndoe/my_forked_repo
-export VERSION=feature/yxz
+export REVISION=feature/yxz
 make exporter-obs-workdir
 ``` 
 will prepare to commit on OBS into `home:JohnDoe/prometheus-ha_cluster_exporter` by checking out the branch `feature/yxz` from `github.com/johndoe/my_forked_repo`.

packaging/obs/grafana-ha-cluster-dashboards/_service

@@ -2,7 +2,7 @@
     <service name="tar_scm" mode="disabled">
         <param name="url">git://github.com/%%REPOSITORY%%.git</param>
         <param name="scm">git</param>
-        <param name="revision">%%VERSION%%</param>
+        <param name="revision">%%REVISION%%</param>
         <param name="include">dashboards</param>
         <param name="include">LICENSE</param>
         <param name="versionformat">1.0.0+git.%ct.%h</param>

packaging/obs/prometheus-ha_cluster_exporter/_service

@@ -2,9 +2,12 @@
     <service name="tar_scm" mode="disabled">
         <param name="url">git://github.com/%%REPOSITORY%%.git</param>
         <param name="scm">git</param>
-        <param name="revision">%%VERSION%%</param>
-        <param name="exclude">.git,dashboards</param>
-        <param name="versionformat">@PARENT_TAG@+git.%ct.%h</param>
+        <param name="revision">%%REVISION%%</param>
+        <param name="exclude">.git</param>
+        <param name="exclude">.github</param>
+        <param name="exclude">dashboards</param>
+        <param name="exclude">packaging/obs/grafana-ha-cluster-dashboards</param>
+        <param name="version">%%VERSION%%</param>
         <param name="filename">prometheus-ha_cluster_exporter</param>
     </service>
     <service name="set_version" mode="disabled">