Skip to content

Latest commit

 

History

History
318 lines (195 loc) · 12.9 KB

CHANGELOG.md

File metadata and controls

318 lines (195 loc) · 12.9 KB
Raw

Cogito Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[v0.12.2] - UNRELEASED

Added

  • Optional source.omit_target_url. If set to true, will omit the GitHub Commit status API target_url (see README).
  • pkg/sets: add Intersect() and Add() methods.

[v0.12.1] - 2024-04-03

Minor breaking change

  • source.log_level.
    • The README was wrongly still mentioning silent as a way to silent the logging. Actually silent was remapped to info since v0.8.2.
    • Starting from this version, levels silent and off will cause an error.
    • The only supported log levels are debug, info, warn, error. The default level, info, is recommended for normal operation.

Fixed

  • Properly encode space characters in build links for instanced pipelines.

Changed

  • Update to Go 1.22

Removed

  • Replaced module github.com/hashicorp/go-hclog with stdlib log/slog.

[v0.12.0] - 2023-11-03

Added

  • Support GitHub Enterprise (see source.github_hostname in the README). Initial implementation by @wanderanimrod and @dev-jin.

v0.11.0 - 2023-09-22

Added

  • Retry GitHub API HTTP request when rate limited or when transient server error:
    • New generic and customizable retry package, usable with any API (not GitHub specific).
    • New Retry adapters for the GitHub API in the github package, usable for any GitHub API, not only the Commit Statuses API.
    • Easily integrable also by tools using the go-github package, although not dependent upon it.

Removed

  • Previous code to retry GitHub API HTTP request when rate limited or when transient server error.

Changed

  • Update to Go 1.21

v0.10.3 - 2023-08-09

Fixed

  • Retry GitHub HTTP request when rate limited: the fix for #124 introduced a new bug. This fixes it. #132

v0.10.2 - 2023-07-28

Fixed

  • Retry GitHub HTTP request when rate limited: fix internal error: unexpected: negative sleep time: 0s #124.

Changed

  • Retry GitHub API HTTP request when rate limited or when transient server error: log the reason for retrying #123.

v0.10.1 - 2023-05-31

Added

  • Retry GitHub HTTP request when rate limited: add a jitter to the calculated sleep time to prevent creating a Thundering Herd.

Fixed

  • Retry GitHub HTTP request when rate limited: fix a bug that caused a negative sleep time due to the clock difference between GitHub and the host running Cogito.

v0.10.0 - 2023-04-28

Added

  • Retry GitHub HTTP requests when rated limited or when transient server error.
    • When rate limited: retry up to 3 times for a maximum of 15 minutes.
    • When transient server errors (status codes 500 Internal Server Error, 502 Bad Gateway, 503 Service Unavailable, 504 Gateway Timeout): retry up to 3 times, with fixed wait time between retries of 5 seconds.

v0.9.0 - 2023-03-16

  • This release allows to use cogito purely to send chat notifications, completely independently of GitHub. This allows to use cogito in place of concourse-hangouts-resource in any situation.

Added

  • Notion of sink, representing an API destination (github and gchat). The optional keys source.sinks and put.params.sinks allow further control on the destination of a put.

Changed

  • Configuring a GitHub repository is not mandatory anymore, to allow cogito to be used purely for chat notification.
  • Documentation addresses explicitly how to configure cogito based on the three possible use cases: GitHub only, GitHub + Chat, Chat only.

v0.8.2 - 2022-11-18

Minor breaking change

  • source.log_level. If you were previously silencing the logging with level silent, it will now be interpreted as invalid and automatically remapped to info. If you really want no logging, the log level to use is off. Note that there is no reason to disable logging, since it is not visible in the build log in the UI, and the default of info helps to, for example, know which version of cogito is being used.

v0.8.1 - 2022-09-07

This release allows to use cogito for the vast majority of chat notifications where previously one would have needed a mix of cogito and concourse-hangouts-resource.

Added

  • Google Chat: allow selecting which states trigger a notification to the chat, via configuration source.chat_notify_on_states. Default (as before this tunable): [abort, error, failure].
  • Google Chat: enrich cogito logging with human-readable information about the chat space.
  • Google Chat: allow to specify a different chat space/webhook during put (see put.params.gchat_webhook).
  • Google Chat: allow to specify a custom chat message, (see params.chat_message).
  • Google Chat: allow to specify a file containing a custom chat message (see put.params.chat_message_file).
  • Google Chat: when passing a custom message or a custom message file, choose whether to append to it the default build summary or not (see source.chat_append_summary, put.params.chat_append_summary). Default: true.

v0.8.0 - 2022-08-11

Changed

  • Redesign of the whole cogito code, based on the removal of the ofcourse package. This simplifies the code and allows to use more of the Go type system (JSON is parsed into typed Go structs, instead of string maps): many validations are done directly by the JSON parser.
    • The behaviour should be unchanged.
    • Some error messages when parsing the pipeline configuration (source and params) are slightly different, but should cover the same area.
  • Increase test coverage, simplify tests.
  • Replace logging library. Log amount and content should be the same; some formatting differences.
  • OCI image size (compressed, reported by DockerHub) is 30% smaller, from 7.5 MB to 5.09 MB.

v0.7.1 - 2022-07-04

Added

  • Support state abort. If the state is abort, we map it to error when using the GitHub Commit status API, and we leave it as-is when sending a chat notification. See the example on_abort hook in the README and section Build states mapping.
  • More debug logging: see clearly which features are enabled (GitHub Commit status, Google Chat notification) and the reason for skipping the sending of a chat message.

v0.7.0 - 2022-05-24

Added

  • Integration with Google Chat (optional). This allows to reduce the verbosity of a Concourse pipeline and especially to reduce the number of resource containers in a Concourse deployment, thus reducing load. Notification is sent only on states abort, error and failure.

Somehow breaking

  • Rename github.NewStatus to github.NewCommitStatus. This impacts only Go source code using the github package; it does NOT impact the cogito Concourse resource in any way.

Changed

  • Update to Go 1.18.
  • Code cleanups.

v0.6.2 - 2022-01-24

Added

  • Support the case where the git remote URL contains basic auth information (this doesn't happen with the Concourse git resource, but can happen with a PR resource, see #46 for a discussion). Thanks @Mike-Dax for the initial implementation (#46).

Changed

  • Extensive code and tests refactoring.

Fixed

  • Return more user-friendly errors from the github/status API.
  • Return more user-friendly errors when validating the Cogito and git configuration.

v0.6.1 - 2022-01-06

Breaking

  • Since Concourse 7.x finally prints logging output also for the check step, we removed support for logging the output of the check step to Google Chat: now all output is printed to the web UI and to fly check-rersource. The log_url attribute for the source configuration is DEPRECATED, will be removed in a future release and is a no-op.

Changed

  • CI: move from Travis to GitHub Actions.
  • tests: new Task targets test:unit (replaces target test) and test:integration (replaces target test-integration).
  • build: cleaner Taskfile.

Fixed

  • Return standard error description in addition to the error code from the github/status API.

v0.6.0 - 2021-08-26

Added

  • Documentation: more details about integration tests and explain how to test instanced pipelines.
  • Support Concourse 7.4 instanced pipelines: the "details" URL in the GitHub status commit will link to the correct instanced pipeline. Thanks @lsjostro for the initial implementation (#26).

Changed

  • Allow http schema in the URI of the git resource (in addition to https and ssh). This change is transparent to the user and allows to use a HTTP-only git proxy of GitHub. Thanks @lsjostro for the initial implementation (#27).
  • Better log messages for Info and Debug level.
  • Renamed e2e tests to integration tests.

v0.5.1 - 2021-07-06

Changed

  • give better error message to the user when the resource is misconfigured

Fixed

  • remove flawed logic attempting to find the real cause when receiving an opaque GitHub API error. Instead, we now print to the user all the possible reasons.

v0.5.0 - 2021-03-09

Changed

  • tests: where it makes sense, remove the need to perform integration tests. For the resource package, total coverage stayed the same, but the non-integration coverage went from 53% to 89%.

Added

  • Optional source configuration context_prefix, that will be prepended to the context. See Effects on GitHub of the README. Thanks @tgolsson for the discussion (#24) and for the initial implementation (#25). Thanks @eitah for a similar discussion (#23).
  • Optional put step parameter context, that will override the default current job name. See Effects on GitHub of the README. Thanks @eitah for the discussion (#23).

v0.4.0 - 2021-03-05

Fixed

  • Now the output correctly identifies the Docker tag: 
    This is the Cogito GitHub status resource.
Tag: update-tooling, commit: 5dbf3c4296, build date: 2021-03-04

Changed

  • Go 1.16
  • Task > 3
  • Moved from envchain to gopass to store secrets for integration tests (see file CONTRIBUTING.md).
  • Documentation enhancements.

Added

  • document how Cogito uses the GitHub API.

v0.3.0 - 2019-11-14

Changed

  • Cogito is now open source.
  • Docker images available at https://hub.docker.com/r/pix4d/cogito
  • The cogito.yml sample pipeline is fully parametric.
  • Renamed DEVELOPMENT file to CONTRIBUTING.

Added

  • Build and release via Travis.
  • Extensive documentation.

v0.2.1 - 2019-10-22

Fixed

  • Always return a non-null version also for a get step. This is unlikely to have caused any problem, but better safer than sorry.

v0.2.0 - 2019-10-16

Fixed

  • If the git resource has a tag_filter, cogito parsing of the commit SHA is broken.
  • If the git repo is in detached HEAD state, cogito parsing of the commit SHA is broken.
  • The context of Cogito notifications make it impossible to use GitHub branch protection rules.

Changed

  • integration tests are now fully parametric, so that any contributor can run their integration tests.
  • Split contributing and developing information from README into their own DEVELOPMENT (then CONTRIBUTING) file.
  • Simplify testdata

Added

  • Support for gotestsum, see DEVELOPMENT (then CONTRIBUTING) file.
  • Provide better GH API error diagnostics via heuristics to workaround GH API bug (see commit comments for 2c812c6 for details).

v0.1.0 - 2019-09-23

Added

  • First version, deployed in production at Pix4D.