v0.7.0

Added

• (GH-80) Add ServiceState type

Changed

• Dependencies
  • actions/setup-node
    • (v2.2.0 to v2.4.0

Fixed

• (GH-76) Fix typo in doc comment for ExitStatusCode field
• (GH-82) Typo in UNKNOWN state label text

References

• See the v0.7.0 milestone for the issues associated with this release.
• See our CHANGELOG for more information.

v0.6.1

Changed

• Panic error message
  • (GH-69) stack trace wrapped with Markdown code fences instead of pre
    tags
  • (GH-68) provide complete stack trace instead of snippet
• Documentation
  • Replace GoDoc badge with pkg.go.dev badge
• Dependencies
  • actions/setup-node
    • (v2.1.4 to v2.2.0
    • update node-version value to always use latest LTS version instead of
      hard-coded version

References

• See the v0.6.1 milestone for the issues associated with this release.
• See our CHANGELOG for more information.

v0.6.0

Added

• Expose panic error message
  • emit as first line item in pre block above stack trace
  • emit as part of error entry

References

• See the v0.6.0 milestone for the issues associated with this release.
• See our CHANGELOG for more information.

v0.5.3

Changed

• dependencies
  • actions/setup-node
    • v2.1.2 to v2.1.4

Fixed

• Preformatted ServiceOutput string subjected to another (failed) formatting operation
• Breadcrumb URL formatting

References

• See the v0.5.3 milestone for the issues associated with this release.
• See our CHANGELOG for more information.

Release v0.5.2

Changed

• dependencies
  • actions/setup-node
    • v2.1.1 to v2.1.2
  • actions/checkout
    • v2.3.2 to v2.3.4

Fixed

• (*nagios.ExitState).ReturnCheckResults() unintentionally masks or "swallows"
  panics

References

• See the v0.5.2 milestone for the issues associated with this release.
• See our CHANGELOG for more information.

Release v0.5.1

Changed

• ExitState receiver type is now a pointer for ReturnCheckResults() method

Fixed

• Documentation
  • Update doc comments and README examples to (hopefully) better explain
    method usage

References

• See the v0.5.1 milestone for the issues associated with this release.
• See our CHANGELOG for more information.

Release v0.5.0

Changed

• Add explicit state labels to threshold list items
  • CRITICAL: and a single space
  • WARNING: and a single space
  • BREAKING: this will require updates to client code to accommodate this
    change
• Update whitespace/EOL handling within Long Service Output or DETAILED INFO section
  • BREAKING: this will require updates to client code to accommodate this
    change

Fixed

• Don't assume that state thresholds will be provided
• YYYY-MM-DD changelog version entries

References

• See the v0.5.0 milestone for the issues associated with this release.
• See our CHANGELOG for more information.

Release v0.4.0

Added

• Add initial "framework workflow"
  • ExitState type with ReturnCheckResults method
    • used to process and return all applicable check results to Nagios for
      further processing/display
    • supports "branding" callback function to display application name,
      version, or other information as a "trailer" for check results provided
      to Nagios
      • this could be useful for identifying what version of a plugin
        determined the service or host state to be an issue
  • README
    • extend examples to reflect new type/method

Changed

• GoDoc coverage
  • simple example retained, reader referred to README for further examples

Fixed

• GitHub Actions Workflow shallow build depth
• YYYY-MM-DD changelog version entries

References

• See the v0.4.0 milestone for the issues associated with this release.
• See our CHANGELOG for more information.

Release v0.3.1

Added

• Docker-based GitHub Actions Workflows

  • Replace native GitHub Actions with containers created and managed through
    the atc0005/go-ci project.

  • New, primary workflow

    • with parallel linting, testing and building tasks
    • with three Go environments
      • "old stable"
      • "stable"
      • "unstable"
    • Makefile is not used in this workflow
    • staticcheck linting using latest stable version provided by the
      atc0005/go-ci containers

  • Separate Makefile-based linting and building workflow

    • intended to help ensure that local Makefile-based builds that are
      referenced in project README files continue to work as advertised until
      a better local tool can be discovered/explored further
    • use golang:latest container to allow for Makefile-based linting
      tooling installation testing since the atc0005/go-ci project provides
      containers with those tools already pre-installed
      • linting tasks use container-provided golangci-lint config file
        except for the Makefile-driven linting task which continues to use
        the repo-provided copy of the golangci-lint configuration file

  • Add Quick Validation workflow

    • run on every push, everything else on pull request updates
    • linting via golangci-lint only
    • testing
    • no builds

• Add new README badges for additional CI workflows

  • each badge also links to the associated workflow results

Changed

• Disable golangci-lint default exclusions

• dependencies

  • go.mod Go version
    • updated from 1.13 to 1.14
  • actions/setup-go
    • updated from v2.1.0 to v2.1.2
      • since replaced with Docker containers
  • actions/setup-node
    • updated from v2.1.0 to v2.1.1
  • actions/checkout
    • updated from v2.3.1 to v2.3.2

• README

  • Link badges to applicable GitHub Actions workflows results
  • Add Table of contents

• Linting

  • Local
    • Makefile
      • install latest stable golangci-lint binary instead of using a fixed
        version
  • CI
    • remove repo-provided copy of golangci-lint config file at start of
      linting task in order to force use of Docker container-provided config
      file

References

• See the v0.3.1 milestone for the issues associated with this release.
• See our CHANGELOG for more information.

Release v0.3.0

Added

• Add State "labels" to provide an alternative to using literal state strings

• Add GitHub Actions Workflow, Makefile for builds

  • Lint codebase
  • Build codebase

• Enable Dependabot updates

  • GitHub Actions
  • Go Modules

Changed

• BREAKING: Rename existing exit code constants to explicitly note that they
  are exit codes

  • the thinking was that since we have text "labels" for state, it would be
    good to help clarify the difference between the new constants and the
    existing exit code constants

• Minor tweaks to README to reference changes, wording

• Update dependencies

  • actions/checkout
    • v1 to v2.3.1
  • actions/setup-go
    • v2.0.3 to v2.1.0
  • actions/setup-node
    • v1 to v2.1.0

References

• See the v0.3.0 milestone for the issues associated with this release.
• See our CHANGELOG for more information.