Improve lint, build, CI, and release process

[cdzombak]

Motivated by recent work with Docker and GitHub Actions on a personal project, plus this repo's insistence on trying to push PR branches to Docker, I've revamped how this repo is versioned, linted, built, and released:

• The program now has a version number, injected during the build process and viewable with the -version flag.
• A Makefile has been added to assist in local development and CI. It prints documentation if you run make with no targets or make help.
• The CI lint-and-build process runs on all pushes to main, v*.*.* tags, and PRs.
• PRs are now linted, and binaries, .debs, and Docker images are built. PR build products are not released anywhere.
• GitHub releases happen automatically when a vX.Y.Z tag is pushed. Binaries and .debs are attached.
  • Tags like vX.Y.Z-alpha.A, -beta.B, and -rc.N are also supported. These generate a GitHub prerelease.
  • Released (not prereleased) Debian packages are pushed to PackageCloud.
  • Lint failures block releases from happening.
• Docker images are pushed to Docker Hub and GHCR:
  • On every release: the tags latest, X.Y.Z, X.Y, and X are pushed
  • On pushes to main: the main tag is pushed
  • The README is updated in Docker Hub on every release
• All source in the repo now passes a battery of lint checks.
• The Dockerfile now uses a two stage build, resulting in a tiny final image. A variety of labels including metadata are added.
• Sample configuration files are renamed.
• Various other minor changes.

[cdzombak]

@ablyler can you take a look at this when you have time? 🙇🏻

[github-actions]

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ ACTION	actionlint	1		0	0.24s
✅ BASH	bash-exec	1		0	0.0s
✅ BASH	shellcheck	1		0	0.02s
✅ BASH	shfmt	1	0	0	0.04s
✅ DOCKERFILELINT	dockerfilelint	1		0	0.32s
✅ GO	revive	1		0	1.02s
✅ JSON	eslint-plugin-jsonc	1	0	0	1.32s
✅ JSON	jsonlint	1		0	0.27s
✅ JSON	prettier	1	0	0	0.4s
✅ JSON	v8r	1		0	1.8s
✅ MARKDOWN	markdownlint	1	1	0	0.93s
✅ MARKDOWN	markdown-link-check	1		0	2.53s
✅ MARKDOWN	markdown-table-formatter	1	1	0	0.46s
✅ MDLINKCHECK	linkcheck	1	0	0	2.7s
✅ YAML	prettier	4	2	0	0.61s
✅ YAML	v8r	4		0	5.6s
✅ YAML	yamllint	4		0	0.43s

See detailed report in MegaLinter reports

You could have same capabilities but better runtime performances if you request a new MegaLinter flavor.

• Click here to request the new flavor

MegaLinter is graciously provided by

[cdzombak]

One unknown: when running the minimal from-scratch Docker image, will TLS validation be a problem for the Ecobee API / if anyone is running InfluxDB with TLS?

• https://stackoverflow.com/questions/65297751/docker-container-with-golang-http-get-error-certificate-signed-by-unknown-autho
• https://www.reddit.com/r/docker/comments/ordgws/embedding_ssl_certificates_in_a_from_scratch_image/

[cdzombak]

@theonlytruebigmac curious to hear any input you have on this, too 🙇🏻

[ablyler]

Looks great to me! Very nice improvements!

[ablyler]

One unknown: when running the minimal from-scratch Docker image, will TLS validation be a problem for the Ecobee API / if anyone is running InfluxDB with TLS?

• https://stackoverflow.com/questions/65297751/docker-container-with-golang-http-get-error-certificate-signed-by-unknown-autho
• https://www.reddit.com/r/docker/comments/ordgws/embedding_ssl_certificates_in_a_from_scratch_image/

I'll try to build the docker image and run it against this branch. I do not have TLS enabled for InfluxDB, but I can test the Ecobee API.

[ablyler]

I had to make some minor changes to get the docker image to work correctly, including adding the ca certs. It works on my machine now. 👍

[cdzombak]

@ablyler awesome, thanks!

Next year's first (planned) Big House Expense is likely going to be new HVAC, and then I'll have an Ecobee to test with again ;)

[cdzombak]

Now letting v1.0.0-rc.1 build: https://github.com/cdzombak/ecobee_influx_connector/actions/runs/6263222668 \o/