Skip to content

Latest commit

 

History

History
411 lines (328 loc) · 18.3 KB

CHANGELOG.md

File metadata and controls

411 lines (328 loc) · 18.3 KB
Raw

Changelog

This changelog contains a loose collection of changes in every release. I will also try and document all breaking changes to the API. However, as this is still an experimental library, breaking changes may occur without warning between 0.X.Y releases.

The official release will have a defined and more stable API. If you are already relying on a particular API, please let me know.

0.8.0

  • Improvements:
    • UI: Trigger symbol is now visible before a manual trigger is reached (#97)
  • Bug fixes:
    • UI did not display the second detail if it had the same label as the first (#98)
  • Breaking Changes:

    • LambdaCD no longer depends on Logback as a logging implementation and gives you more freedom to choose a logging implementation. If you see the following message you need to add a dependency to a library that's compatible with SLF4J:

      SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

      The default dependencies were:

      [ch.qos.logback/logback-core "1.0.13"]
[ch.qos.logback/logback-classic "1.0.13"]

    • LambdaCD no longer depends on ring-server and leaves the decision on how you serve the UI to you. If you see the following error, you were probably using ring-server and need to add it to your dependencies:

      Exception in thread "main" java.io.FileNotFoundException: Could not locate ring/server/standalone__init.class or ring/server/standalone.clj on classpath.

      The default dependency was:

      [ring-server "0.3.1"]

0.7.1

  • Improvements:
    • UI: Adds ability to display preformatted text in step result details (#89)
    • UI: Honors ASCII escape sequences like \r in console output (#88)
  • Bug fixes:
    • UI: Unicode Characters displayed as ??? (#92)
    • Chaining macro did not inject args and ctx if they were referred to via the namespace (#93)
    • Fixed merging of step results when both values in the maps to be merged are seqs (#95) (thanks @thilo11)

0.7.0

  • Improvements:
    • Adds public functions to simplify building custom build state aggregations (#84)
      • lambdacd.presentation.pipeline-state/overall-build-status
      • lambdacd.presentation.pipeline-state/latest-most-recent-update
      • lambdacd.presentation.pipeline-state/earliest-first-update
      • lambdacd.presentation.pipeline-state/build-duration
      • Renames namespace lambdacd.internal.step-id to lambdacd.step-id to officially make it public. In case someone was using the internal namespace, it is still there but is considered DEPRECATED and will be removed in subsequent releases.
    • UI: Link LambdaCD header to "/" to link back to overview in cases with multiple pipelines (#82)
    • UI: Refactored the server side UI code to make it simpler to customize the UI (#83)
  • Bug fixes:
    • with-workspace now creates temporary directories in the home-dir (#79)
  • API Changes:
    • lambdacd.presentation.pipeline-state/most-recent-build-number-in seems to be unused and now considered DEPRECATED. Will be removed in subsequent releases.
    • Removed (ui-server/ui-for pipeline-def pipeline-state ctx) (deprecated since 0.4.3). Use (ui-server/ui-for pipeline) instead.

0.6.1

  • Improvements:
    • Adds with-workspace container step that allows users to run operations in the context of a clean workspace on disk (#72)
    • UI: expand active steps per default

0.6.0

  • Improvements:
    • UI: Adding feature to collapse/expand all, only active or only failed steps (#59)
  • Bug fixes:
    • either no longer aggregates to failure if only some children failed (#67)
    • in-parallel no longer aggregates to failure while other children are still running (#68)
  • Breaking Changes:
    • successful-when-one-successful status aggregation only fails if all statuses are :failure (#67)
    • successful-when-all-successful-sequential status aggregation doesn't fail while other steps are still running (#68)

0.5.7

  • Improvements:

    • UI: Displaying duration of each build step (#34)

    • Prevent retriggering of steps that have dependencies to previous steps by adding :depends-on-previous-steps true to metadata:

      (defn ^{:depends-on-previous-steps true} publish-artifact [{cwd :cwd} ctx]
  (shell/bash ctx cwd
              "./publish.sh"))

      This can be useful if several steps work on a workspace created by a nested step (such as with-git) and rely on the products of previous steps. See #36 for details.

    • Improved calculation of build duration for retriggered pipelines (#30)

    • UI: collapsing child steps by default (#59)

    • Add feature to alias build steps in UI:

      ; this displays "trigger" instead of "either" in UI
(alias "trigger"
  (either
    wait-for-manual-trigger
    wait-for-repo))

    • UI: Added feedback after killing a step

    • Killing a shell/bash-step now kills the whole process tree spawned by it. This helps in cases where the step spawns longer-running processes and bash doesn't pass on the TERM signal to its children)

    • Fixed UI bug where pipeline was no longer visible for long step output

0.5.6

  • Improvements:

    • Added lambdacd.steps.support/capture-output to simplify working with stdout in build-steps (#60)

    • Added lambdacd.steps.support/chaining, a more flexible and powerful variant of the existing chain macro. (#39) It supports injecting args and ctx at random places and, together with capture-output, also allows for easy debugging:

      (chaining {} {}
  (some-step injected-args injected-ctx)
  ; prints the foo value that's returned by some-step and is injected into some-other-step
  (print "foo-value:" (:foo injected-args)) 
  (some-other-step injected-args injected-ctx))

      This change also DEPRECATES lambdacd.steps.support/chain which will be removed in subsequent releases.

  • Bug fixes:
    • :global values can now be overwritten by later stages in the pipeline (#61)

0.5.5

  • Improvements:
    • UI: redesigned build history:
      • added information on when the build was triggered (#52)
      • added information when a build was retriggered

0.5.4

  • Improvements:
    • UI: Display Pipeline-Name in title tag of UI if configured.
    • UI: Prettier favicon (thanks @alphaone for this)
    • UI: Jump to most recent build if none given
  • Bug fixes:
    • Fix bug that led to wrong first-updated-at timestamps when retriggering children of container-steps (#56, flosell/lambdacd-cctray#3)
    • UI: fix bug that led to console output being refreshed all the time, making selecting text hard (#53)
    • UI: fix bug that broke UI in Firefox 41 (#57)
  • Breaking Changes:
    • LambdaCD now requires Clojure 1.7

0.5.3

  • Improvements:
    • Adding with-git-branch that always checks out the latest commit on a particular branch (as opposed to with-git which checks out a revision given in args or the master branch in case nothing is given) (#46) (thanks @exload for this)
    • UI: Further improvements to scrolling behavior with long pipelines
  • Bug fixes:
    • Fix a bug that lead to the fact that container steps that were the only children of another container step would not be shown in the UI (#47)

0.5.2

  • Improvements:
    • UI: display the name of the pipeline if config contains a value for :name
    • UI: make sure build history doesn't shrink when pipeline content is very long
    • UI: make sure long pipeline output doesn't spill over the visible width
    • UI: remove alert after clicking the manual trigger

0.5.1

  • Improvements:

    • Made :display-type :container the default for container steps, no longer throwing incomprehensible exceptions when display-type declarations are forgotten (#43)

    • Now supporting steps with parameters in the pipeline:

      (defn mk-pipeline-def [{repo-uri :repo-uri test-command :test-command}]
  `(
     wait-for-manual-trigger
     (with-repo ~repo-uri
                (run-tests ~test-command)
                publish)))

    • Polished the UI

0.5.0

  • Improvements:
    • UI: add support for :details field in step-results to display details about a build step result and link to more detailed information (e.g. test reports) (#37)
    • UI: packaged icon font instead of relying on external CDN
    • UI: added vendor prefixes in CSS to improve browser support (esp. Firefox and Safari)
    • Extracted common functions from internal.default-pipeline-state so they can be reused in other persistence components (#38)
    • Generalized pipeline-state-updater to be started by assemble-pipeline and pushes updates to any pipeline-state component that is configured (#38)
    • support alternative pipeline-state component in assemble-pipeline (#40)
    • fixed bug where either didn't kill remaining steps after finishing
    • REST api endpoint /api/builds/<buildnumber>/ now returns status 404 in case the build does not exist instead of returning a half empty data-structure (#42)
  • API changes:
    • Remove deprecated access to the internal pipeline-state through :state in the result of assemble-pipeline
    • Remove deprecated :step-results-channel
    • pipeline-state-updater now started by assemble-pipeline (see above), pipeline-state component should no longer start their own update mechanism (#38)

0.4.3

Housekeeping release: Contains mostly cleanup under the hood and changes to APIs for advanced users. If you are using custom control-flow steps, runners, persistence mechanisms or other advanced features, make sure you look through the changes and upgrade as future releases will remove deprecated functionality.

  • Improvements:
    • Now providing events :step-result-updated and :step-finished on event-bus for use by other components like runners and persistence components (#38)
    • Clarified interface for core/execute-step
  • API changes:
    • The :step-results-channel is now deprecated, unsupported and will be removed in subsequent releases. Use the new :step-result-updated event and filter on :step-id to receive updates from child-steps while they run.
    • (ui-server/ui-for pipeline-def pipeline-state ctx) is now deprecated and will be removed in subsequent releases. Use (ui-server/ui-for pipeline) instead.
    • Direct access to the pipeline-state atom, e.g. through :state in the result of assemble-pipeline is now deprecated and will be removed in subsequent releases. Use the event-bus or access the state through the PipelineStateComponent protocol instead.
    • Removed default-pipeline-state/notify-when-no-first-step-is-active. Use the new events (see above) to be notified about changes to the state of the pipeline

0.4.2

  • Improvements:

    • Increased time between git-polls in git/wait-for-git and git/wait-for-details to 10 seconds and made that value configurable with an optional parameter :ms-between-polls, e.g.

      (git/wait-with-details ctx some-repo-uri "master" :ms-between-polls 60000)

    • Added a feature to kill running steps on user request (#31)

0.4.1

  • Improvements:
    • Added junction control flow step that adds a way to model if-then-else logic in a pipeline (#28,#32)
    • No longer shipping a logback.xml in the published jar.

0.4.0

  • Improvements:
    • Cleaned up status inheritance to make it more consistent
    • Support variable arguments instead of step-vector as input for chain-steps (#29)
    • Internal refactorings to prepare for more component-oriented structure
    • Contexts always contain :step-results-channel which can be used to access a stream of step-state updates, e.g. to create custom persistence components or runners (still experimental)
    • Cleaned up dependencies
  • Bug fixes:
    • Fix bug in retriggering that left next step in undefined state (#26)
  • API changes:
    • Steps returning no :status will now be treated as failures instead of receiving status :undefined
    • Removed deprecated :result-channel argument for execute-step
    • Removed deprecated core/new-base-context-for
    • core/execute-step does no longer output the result-channel data to a :result-channel in ctx. Was replaced with :step-results-channels which provides a stream of complete, aggregated step-result data
    • Calling lambdacd.steps.support/chain-steps with a vector instead of just the steps is now deprecated (#29)

0.3.2

  • Improvements:
    • Remove styling for undefined step-status (#23)
    • All container steps inherit their childrens status by default (#24)
    • Add a run-container step that can group nested steps (#21)
    • Ignore step-results cloned by retriggering in determining start and stop timestamps in pipeline history (#22)
    • UI: build-history now in descending order (i.e. recent builds first) (#25)
  • API changes:
    • the :result-channel argument for execute-step is now deprecated. Pass custom result-channels in via the ctx instead
    • Generating a new base context moved to execute-step, therefore core/new-base-context-for is now deprecated, just use ctx instead

0.3.1

  • Bug fixes:
    • Fix updated scrolling (#18)

0.3.0

  • Bug fixes: #14, #15, #17
  • Improvements:
  • Display status in output at the end of a build step (#4)
  • Display total build time in history (#16)
  • Indicate lost connection to LambdaCD in UI
  • Allow retriggering of nested steps (#5)
  • Redirect to new build when retriggering
  • Support hardcoded result-maps in chain-macro
  • Support setting environment-variables in shell/bash (#9)
  • API Changes:
  • removed deprecated argument lists for lambdacd.internal.execution/execute-steps

0.2.3

  • Bug fixes: #13

0.2.2

  • Bug fixes: #8, #10, #11, #12
  • New features:
    • support/print-to-output simplifies printing to the output-channel within a step
    • support/printed-output in return allows you to get everything that was printed within that step, typically to return at the end of a step
  • Improvements:
    • with-git removes its workspace after all child-steps are finished
    • Display build status in history (#3)
  • API Changes
    • lambdacd.internal.execution/execute-steps is now deprecated. use the public lambdacd.core/execute-steps instead. (#7) lambdacd.core/execute-steps takes keyword-arguments instead of argument lists for optional parameters.
    • lambdacd.internal.execution/execute-step is now deprecated. use the public lambdacd.core/execute-step instead. (#7)

0.2.1

  • UI: support safari and other older browsers
  • Step-Chaining now passes on the initial arguments to all the steps to enable users to pass on parameters that are relevant for all steps, e.g. a common working directory.
  • wait-for-git no longer returns immediately when no last commit is known. Instead just waits for the first commit. This behavior seems more intuitive since otherwise on initial run, all build pipelines would start running.
  • Git-Support: added with-commit-details, a function that enriches the wait-for-git result with information about the commits found since last build and a convenience function wait-with-details that wraps both.

0.2.0

  • Recording start and update timestamps for every build step
  • Cleanup old endpoints: /api/pipeline and /api/pipeline-state
  • Improve retriggering: Create a new pipeline-run instead of overwriting existing builds
  • Make bash-step killable
  • Breaking Changes:
  • removed core/mk-pipeline as a method to initialize the pipeline. Replaced with a more flexible core/assemble-pipeline and a few single functions that take over things like running the pipeline and providing ring-handlers to access the pipeline. For details, see examples.

0.1.1

  • Improvements in UI

0.1.0

  • LambdaCD now requires Clojure 1.6.0

0.1.0-alpha13

  • Major restructuring: (scripts/migrate-to-new-package-structure.sh can help rewrite your code to work with the new structure)
    • control-flow, git, manualtrigger and shell are now in steps-package
    • lambdacd.presentation is now lambdacd.presentation.pipeline-structure
    • some functions more concerned with presentation than actual management of the pipeline state are moved from lambdacd.pipeline-state to lambdacd.presentation.pipeline-state
    • internals are now in the internal package
    • ui related functionality is now in the ui package

0.1.0-alpha12

0.1.0-alpha11

  • Removed support for steps returning channels (deprecated since alpha8)

0.1.0-alpha10

0.1.0-alpha9

0.1.0-alpha8

  • steps now receive a :result-channel value through the context to send intermediate values. use this channel instead of returning a result-channel from the step. the latter is now DEPRECATED and will be removed in the next release.

  • bash now needs the context as first parameter:

    (shell/bash ctx cwd
    "lein test")

0.1.0-alpha7

no breaking API changes

0.1.0-alpha6

  • wait-for-git now receives the context as first parameter: (wait-for-git ctx some-repo some-branch) The context must contain a configuration with the :home-dir set to a directory where the step can store a file with the last seen revisions (see below)
  • mk-pipeline requires and additional parameter, the configuration-map (which is where you set the home-dir)

0.1.0-alpha5

  • just a bugfix for the git-handling

0.1.0-alpha4

  • Pipeline-Steps can now return a core-async channel to continously update their state while the step is running (e.g for long-running steps that need to indicate progress on the UI):
(async/>!! ch [:out "hello"])
(async/>!! ch [:out "hello world"])
(async/>!! ch [:status :success])
(async/close! ch)
  • Dropped support for core-async channels as :status value in a steps result-map. Use channels for the whole result instead (see above)

0.1.0-alpha3

  • parameters for steps changed. the second argument is now a context-map that contains the step-id and other low-level information
    • previously (defn some-step [args step-id])
    • now (defn some-step [args {:keys [step-id] :as ctx}])
  • start-pipeline-thread has been removed as the initializing function. use the new setup-functionality using mk-pipeline:
(def pipeline (core/mk-pipeline pipeline-def))

(def app (:ring-handler pipeline))
(def start-pipeline-thread (:init pipeline))