Doc updates.
This commit is contained in:
parent
ef6421e935
commit
c36d6dabe4
|
|
@ -23,3 +23,6 @@ README.html
|
||||||
/unifi-poller_manual.html
|
/unifi-poller_manual.html
|
||||||
/homebrew_release_repo
|
/homebrew_release_repo
|
||||||
/.metadata.make
|
/.metadata.make
|
||||||
|
bitly_token
|
||||||
|
github_deploy_key
|
||||||
|
.secret_files.tar
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
# Each line must have an export clause.
|
# Each line must have an export clause.
|
||||||
# This file is parsed and sourced by the Makefile, Docker and Homebrew builds.
|
# This file is parsed and sourced by the Makefile, Docker and Homebrew builds.
|
||||||
|
# Powered by Application Builder: https://github.com/golift/application-builder
|
||||||
|
|
||||||
# Must match the repo name.
|
# Must match the repo name.
|
||||||
BINARY="unifi-poller"
|
BINARY="unifi-poller"
|
||||||
|
|
@ -33,7 +34,8 @@ URL="https://github.com/${GHREPO}"
|
||||||
VERSION_PATH="github.com/${GHREPO}/$(echo ${BINARY} | tr -d -- -).Version"
|
VERSION_PATH="github.com/${GHREPO}/$(echo ${BINARY} | tr -d -- -).Version"
|
||||||
|
|
||||||
# Dynamic. Recommend not changing.
|
# Dynamic. Recommend not changing.
|
||||||
VERSION="$(git tag -l --merged | tail -n1 | tr -d v | grep -E '^\S+$' || echo development)"
|
VVERSION=$(git describe --abbrev=0 --tags $(git rev-list --tags --max-count=1))
|
||||||
|
VERSION="$(echo $VVERSION | tr -d v | grep -E '^\S+$' || echo development)"
|
||||||
# This produces a 0 in some envirnoments (like Homebrew), but it's only used for packages.
|
# This produces a 0 in some envirnoments (like Homebrew), but it's only used for packages.
|
||||||
ITERATION=$(git rev-list --count --all || echo 0)
|
ITERATION=$(git rev-list --count --all || echo 0)
|
||||||
DATE="$(date -u +%Y-%m-%dT%H:%M:%SZ)"
|
DATE="$(date -u +%Y-%m-%dT%H:%M:%SZ)"
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,4 @@
|
||||||
|
# Powered by Application Builder: https://github.com/golift/application-builder
|
||||||
language: go
|
language: go
|
||||||
git:
|
git:
|
||||||
depth: false
|
depth: false
|
||||||
|
|
|
||||||
4
Makefile
4
Makefile
|
|
@ -1,6 +1,6 @@
|
||||||
# This# This Makefile is written as generic as possible.
|
# This Makefile is written as generic as possible.
|
||||||
# Setting the variables in .metadata.sh and creating the paths in the repo makes this work.
|
# Setting the variables in .metadata.sh and creating the paths in the repo makes this work.
|
||||||
#
|
# See more: https://github.com/golift/application-builder
|
||||||
|
|
||||||
# Suck in our application information.
|
# Suck in our application information.
|
||||||
IGNORED:=$(shell bash -c "source .metadata.sh ; env | sed 's/=/:=/;s/^/export /' > .metadata.make")
|
IGNORED:=$(shell bash -c "source .metadata.sh ; env | sed 's/=/:=/;s/^/export /' > .metadata.make")
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,8 @@
|
||||||
|
|
||||||
[](https://hub.docker.com/r/golift/unifi-poller)
|
[](https://hub.docker.com/r/golift/unifi-poller)
|
||||||
[](https://www.somsubhra.com/github-release-stats/?username=davidnewhall&repository=unifi-poller)
|
[](https://www.somsubhra.com/github-release-stats/?username=davidnewhall&repository=unifi-poller)
|
||||||

|
[](https://github.com/davidnewhall/unifi-poller)
|
||||||

|
[](https://github.com/golift/unifi)
|
||||||
|
|
||||||
[](https://github.com/davidnewhall/unifi-poller/issues?q=is%3Aissue+is%3Aclosed)
|
[](https://github.com/davidnewhall/unifi-poller/issues?q=is%3Aissue+is%3Aclosed)
|
||||||
[](https://github.com/davidnewhall/unifi-poller/pulls?utf8=✓&q=is%3Apr+)
|
[](https://github.com/davidnewhall/unifi-poller/pulls?utf8=✓&q=is%3Apr+)
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
#
|
#
|
||||||
# building static go binary with Debian golang container
|
# This is part of Application Builder.
|
||||||
|
# https://github.com/golift/application-builder
|
||||||
#
|
#
|
||||||
|
|
||||||
ARG ARCH=amd64
|
ARG ARCH=amd64
|
||||||
|
|
@ -45,7 +46,7 @@ ARG CONFIG_FILE=config.conf
|
||||||
# Build-time metadata as defined at https://github.com/opencontainers/image-spec/blob/master/annotations.md
|
# Build-time metadata as defined at https://github.com/opencontainers/image-spec/blob/master/annotations.md
|
||||||
LABEL org.opencontainers.image.created="${BUILD_DATE}" \
|
LABEL org.opencontainers.image.created="${BUILD_DATE}" \
|
||||||
org.opencontainers.image.title="${BINARY}" \
|
org.opencontainers.image.title="${BINARY}" \
|
||||||
org.opencontainers.image.documentation="${URL}/wiki/Docker" \
|
org.opencontainers.image.documentation="https://github.com/${GHREPO}/wiki/Docker" \
|
||||||
org.opencontainers.image.description="${DESC}" \
|
org.opencontainers.image.description="${DESC}" \
|
||||||
org.opencontainers.image.url="${URL}" \
|
org.opencontainers.image.url="${URL}" \
|
||||||
org.opencontainers.image.revision="${COMMIT}" \
|
org.opencontainers.image.revision="${COMMIT}" \
|
||||||
|
|
|
||||||
|
|
@ -1,15 +1,23 @@
|
||||||
# Docker Build Hooks
|
# Application Builder
|
||||||
|
|
||||||
|
[https://github.com/golift/application-builder](https://github.com/golift/application-builder)
|
||||||
|
|
||||||
|
## Docker Build Hooks
|
||||||
|
|
||||||
The files in this folder are used by Docker Cloud to automate image builds.
|
The files in this folder are used by Docker Cloud to automate image builds.
|
||||||
|
Do not edit these files.
|
||||||
|
|
||||||
If you want to build, maintain and push multi-architecture Docker images, you may
|
If you want to build, maintain and push multi-architecture Docker images, you may
|
||||||
follow the example provided here. All of the hooks are generic, and will work with
|
follow the example provided here. All of the hooks are generic, and will work with
|
||||||
any build. Two environment variables must be passed in from Docker Cloud config.
|
any build. Two environment variables must be passed in from Docker Cloud config.
|
||||||
`BUILDS` must be set to the builds you're trying to perform. This repo is currently
|
|
||||||
set to `linux:armhf:arm: linux:arm64:arm64:armv8 linux:amd64:amd64: linux:i386:386:`.
|
1. `BUILDS` must be set to the builds you're trying to perform. This repo is currently set to:
|
||||||
The format is `os:name:arch:variant`. `os` and `name` are passed into the Dockerfile.
|
- `linux:armhf:arm: linux:arm64:arm64:armv8 linux:amd64:amd64: linux:i386:386:`
|
||||||
`os`, `arch` and `variant` are passed into `docker manifest annotate`. This does not
|
- The format is `os:name:arch:variant`.
|
||||||
yet work with an OS other than `linux`.
|
- `os` and `name` are passed into the Dockerfile.
|
||||||
|
- `os`, `arch` and `variant` are passed into `docker manifest annotate`.
|
||||||
|
- This does not yet work with an OS other than `linux`.
|
||||||
|
1. Set `DOCKER_CLI_EXPERIMENTAL` to `enabled`. Not optional.
|
||||||
|
|
||||||
Keep the build simple; see screenshot. This only supports one build tag, but it creates many more.
|
Keep the build simple; see screenshot. This only supports one build tag, but it creates many more.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,8 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# The Docker Cloud config must pass in the BUILDS env variable.
|
# The Docker Cloud config must pass in the BUILDS env variable.
|
||||||
# See README.md (in this dir) and the screenshot for more info.
|
# See README.md (in this dir) and the screenshot for more info.
|
||||||
|
# This is part of Application Builder.
|
||||||
|
# https://github.com/golift/application-builder
|
||||||
|
|
||||||
set -e -o pipefail
|
set -e -o pipefail
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,6 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
# This is part of Application Builder.
|
||||||
|
# https://github.com/golift/application-builder
|
||||||
|
|
||||||
# https://www.smockle.com/blog/2019/04/22/migrating-from-travis-ci-to-docker-hub-automated-builds/
|
# https://www.smockle.com/blog/2019/04/22/migrating-from-travis-ci-to-docker-hub-automated-builds/
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,8 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# This post build hook creates multi-architecture docker manifests.
|
# This post build hook creates multi-architecture docker manifests.
|
||||||
# It's all a bit complicated for some reason.
|
# It's all a bit complicated for some reason.
|
||||||
|
# This is part of Application Builder.
|
||||||
|
# https://github.com/golift/application-builder
|
||||||
|
|
||||||
set -e -o pipefail
|
set -e -o pipefail
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,6 @@
|
||||||
# Homebrew Formula Template. Built by Makefile: `make fomula`
|
# Homebrew Formula Template. Built by Makefile: `make fomula`
|
||||||
|
# This is part of Application Builder.
|
||||||
|
# https://github.com/golift/application-builder
|
||||||
class {{Class}} < Formula
|
class {{Class}} < Formula
|
||||||
desc "{{Desc}}"
|
desc "{{Desc}}"
|
||||||
homepage "{{URL}}"
|
homepage "{{URL}}"
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,6 @@
|
||||||
# Systemd service unit for {{BINARY}}.
|
# Systemd service unit for {{BINARY}}.
|
||||||
|
# This is part of Application Builder.
|
||||||
|
# https://github.com/golift/application-builder
|
||||||
|
|
||||||
[Unit]
|
[Unit]
|
||||||
Description={{BINARY}} - {{DESC}}
|
Description={{BINARY}} - {{DESC}}
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,10 @@
|
||||||
#!/bin/bash -x
|
#!/bin/bash -x
|
||||||
|
|
||||||
# Deploys a new homebrew formula file to golift/homebrew-tap.
|
# Deploys a new homebrew formula file to a github homebrew formula repo: $HBREPO
|
||||||
# Requires SSH credentials in ssh-agent to work.
|
# Requires SSH credentials in ssh-agent to work.
|
||||||
# Run by Travis-CI when a new release is created on GitHub.
|
# Run by Travis-CI when a new release is created on GitHub.
|
||||||
# Do not edit this file.
|
# Do not edit this file. It's part of application-builder.
|
||||||
|
# https://github.com/golift/application-builder
|
||||||
|
|
||||||
source .metadata.sh
|
source .metadata.sh
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,6 +8,8 @@
|
||||||
# ===
|
# ===
|
||||||
# If you're on redhat, this installs the latest rpm. If you're on Debian, it installs the latest deb package.
|
# If you're on redhat, this installs the latest rpm. If you're on Debian, it installs the latest deb package.
|
||||||
#
|
#
|
||||||
|
# This is part of application-builder.
|
||||||
|
# https://github.com/golift/application-builder
|
||||||
|
|
||||||
REPO=davidnewhall/unifi-poller
|
REPO=davidnewhall/unifi-poller
|
||||||
LATEST=https://api.github.com/repos/${REPO}/releases/latest
|
LATEST=https://api.github.com/repos/${REPO}/releases/latest
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue