build-graph 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aec6fa0f0986fcf74ca7e3c3debb16f96d7001acbb6f2db9ffb6266973520d39
-  data.tar.gz: 13568cfcc7dc26b1d2a1a4dbbcbe26b3b127756caaff3eb92873ce139d094c53
+  metadata.gz: c1db7b0de55419c77b5c17f17e93f4e62304a93872265545cce248c58d78e1c8
+  data.tar.gz: 989d5bae8d7eb3b324648cf64eecdd999c8f5104a849bd5715cab8cd7ad26079
 SHA512:
-  metadata.gz: 368c3f2a8b146ff538ef5381f1d394965a4d7fde720fcd0757b36c578614da8b4ad81a968611a32ca05372278554a08fd4484ea1dd7ab5f59bbcce9564189bdd
-  data.tar.gz: 92233e7a0535b6b89a0e40716c527357c345bf441387e500d86690d690f0bea21e7b1c86c58e335933efe0535f6599f6e0d0125823136484c60e87c0d908710a
+  metadata.gz: 93c3f170fb2ad8da49f56d30248e8403e504f8fef5e562f19cd3280cfa60471cc09b0dc440a6d7f3c63fef7c8da25e1da5e6faacce446c91cbb6e3d9ced740fb
+  data.tar.gz: '0382b9651118034b7aebdfcfa7a0599adf430172ac3ec0243905728b2a2326ca621c44011d7d5a071308e4c1e3bdb83977292fd6a3f9ef2c0b141488edf27329'

data/lib/build/graph/edge.rb

@@ -1,29 +1,16 @@
-# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
 
-require 'fiber'
+# Released under the MIT License.
+# Copyright, 2014-2026, by Samuel Williams.
+
+require "fiber"
 
 module Build
 	module Graph
 		# Represents a set of inputs to a graph node.
 		class Edge
+			# Create a new edge, optionally pre-populated with a number of pending traversals.
+			# @parameter count [Integer] the initial number of pending traversals.
 			def initialize(count = 0)
 				@fiber = Fiber.current
 				
@@ -48,10 +35,12 @@ module Build
 				succeeded?
 			end
 			
+			# @returns [Boolean] whether any traversing task failed.
 			def failed?
 				@failed.size != 0
 			end
 			
+			# @returns [Boolean] whether all traversing tasks succeeded.
 			def succeeded?
 				@failed.size == 0
 			end

data/lib/build/graph/node.rb

@@ -1,25 +1,10 @@
-# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
 
-require 'build/files/state'
-require 'build/files'
+# Released under the MIT License.
+# Copyright, 2014-2026, by Samuel Williams.
+
+require "build/files/state"
+require "build/files"
 
 module Build
 	module Graph
@@ -44,6 +29,7 @@ module Build
 				@inputs.map{|path| path.modified_time}.max
 			end
 			
+			# @returns [Boolean] whether any input or output file is missing from the filesystem.
 			def missing?
 				@outputs.any?{|path| !path.exist?} || @inputs.any?{|path| !path.exist?}
 			end
@@ -74,6 +60,7 @@ module Build
 				return false
 			end
 			
+			# @returns [Boolean] whether this node is equal to another by comparing inputs and outputs.
 			def == other
 				self.equal?(other) or
 					self.class == other.class and
@@ -81,18 +68,25 @@ module Build
 					@outputs == other.outputs
 			end
 			
+			# @returns [Boolean] whether this node is equal to another, for use in Hash and Set.
 			def eql?(other)
 				self.equal?(other) or self == other
 			end
 			
+			# @returns [Integer] a hash value derived from inputs and outputs.
 			def hash
 				@inputs.hash ^ @outputs.hash
 			end
 			
+			# @returns [String] a human-readable representation of the node.
 			def inspect
 				"#<#{self.class} #{@inputs.inspect} => #{@outputs.inspect}>"
 			end
 			
+			# Create a top-level node that inherits its outputs from its children.
+			# @parameter inputs [Build::Files::List] the input files for this node.
+			# @parameter outputs [Symbol] the output strategy, defaults to `:inherit`.
+			# @returns [Node] the constructed top-level node.
 			def self.top(inputs = Files::Paths::NONE, outputs = :inherit, **options, &block)
 				self.new(inputs, outputs, block, **options)
 			end

data/lib/build/graph/task.rb

@@ -1,41 +1,35 @@
-# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2015-2026, by Samuel Williams.
 
 module Build
 	module Graph
+		# An error that represents a transient build failure which can be retried.
 		class TransientError < StandardError
 		end
 		
+		# Mixed in to errors raised when child tasks have failed.
 		module ChildrenFailed
+			# @returns [String] a human-readable error message.
 			def self.to_s
 				"Children tasks failed!"
 			end
 		end
 		
+		# Mixed in to errors raised when tasks generating inputs have failed.
 		module InputsFailed
+			# @returns [String] a human-readable error message.
 			def self.to_s
 				"Tasks generating inputs failed!"
 			end
 		end
 		
+		# Represents a single unit of work within a build graph walk.
 		class Task
+			# Create a new task associated with the given walker and node.
+			# @parameter walker [Walker] the walker driving the graph traversal.
+			# @parameter node [Node] the node this task is responsible for updating.
 			def initialize(walker, node)
 				@walker = walker
 				
@@ -124,10 +118,12 @@ module Build
 				return child_task
 			end
 			
+			# @returns [Boolean] whether the task has failed.
 			def failed?
 				@state == :failed
 			end
 			
+			# @returns [Boolean] whether the task has completed successfully.
 			def complete?
 				@state == :complete
 			end
@@ -142,18 +138,22 @@ module Build
 				end
 			end
 			
+			# Resets the node in the walker if inputs or outputs have changed since the last run.
 			def changed!
 				@walker.delete(@node) if (@inputs.update! or @outputs.update!)
 			end
 			
+			# @returns [Array(String)] the list of root directories for all input and output paths.
 			def directories
 				(@inputs.roots + @outputs.roots).collect{|path| path.to_s}
 			end
 			
+			# @returns [String] a short human-readable summary of the task.
 			def to_s
 				"#<#{self.class} #{node_string} #{state_string}>"
 			end
 			
+			# @returns [String] a detailed human-readable representation including object identity.
 			def inspect
 				"\#<#{self.class}:0x#{self.object_id.to_s(16)} #{node_string} #{state_string}>"
 			end
@@ -210,7 +210,7 @@ module Build
 			
 			# Fail the task with the given error. Any task which is waiting on this task will also fail (eventually).
 			def fail!(error)
-				@walker.logger&.error(self) {error}
+				Console.error(self, "Task failed!", exception: error)
 				
 				@error = error
 				@state = :failed

data/lib/build/graph/version.rb

@@ -1,25 +1,12 @@
-# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2014-2026, by Samuel Williams.
+
+# @namespace
 module Build
+	# @namespace
 	module Graph
-		VERSION = "2.1.1"
+		VERSION = "2.2.0"
 	end
 end

data/lib/build/graph/walker.rb

@@ -1,35 +1,23 @@
-# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
 
-require 'set'
-require 'console'
-require 'build/files/monitor'
+# Released under the MIT License.
+# Copyright, 2014-2026, by Samuel Williams.
 
-require_relative 'task'
-require_relative 'node'
-require_relative 'edge'
+require "set"
+require "console"
+require "build/files/monitor"
+
+require_relative "task"
+require_relative "node"
+require_relative "edge"
 
 module Build
 	module Graph
 		# A walker walks over a graph and applies a task to each node.
 		class Walker
+			# Create a walker that instantiates tasks of the given class for each visited node.
+			# @parameter task_class [Class] the task class to instantiate; must accept `(walker, node, *args)`.
+			# @returns [Walker] a new walker bound to the given task class.
 			def self.for(task_class, *args, **options)
 				self.new(**options) do |walker, node, parent_task = nil|
 					task = task_class.new(walker, node, *args)
@@ -40,7 +28,9 @@ module Build
 				end
 			end
 			
-			def initialize(logger: Console.logger, &block)
+			# Create a walker with a block that is called for each node to create and run a task.
+			# @parameter block [Proc] called with `(walker, node, parent_task)` for each visited node.
+			def initialize(&block)
 				# Node -> Task mapping.
 				@tasks = {}
 				
@@ -55,13 +45,9 @@ module Build
 				@failed_tasks = []
 				@failed_outputs = Set.new
 				
-				@logger = logger
-				@monitor = Files::Monitor.new(logger: @logger)
+				@monitor = Files::Monitor.new
 			end
 			
-			# Primarily for debugging from within Task
-			attr :logger
-			
 			# An Array of all instantiated tasks.
 			attr :tasks
 			
@@ -78,16 +64,22 @@ module Build
 			
 			attr :monitor
 			
+			# Invoke the walker for each node in the given collection.
+			# @parameter nodes [Enumerable] the nodes to update.
 			def update(nodes)
 				Array(nodes).each do |node|
 					self.call(node)
 				end
 			end
 			
+			# Invoke the walker for a single node, reusing an existing task if the node has already been visited.
+			# @parameter node [Node] the node to update.
+			# @parameter parent_task [Task | nil] the parent task, if any.
+			# @returns [Task] the task associated with the node.
 			def call(node, parent_task = nil)
 				# We try to fetch the task if it has already been invoked, otherwise we create a new task.
 				@tasks.fetch(node) do
-					@logger&.debug(self) {"Update: #{node} #{parent_task.class}"}
+					Console.debug(self){"Update: #{node} #{parent_task.class}"}
 					
 					# This method should add the node
 					@update.call(self, node, parent_task)
@@ -97,10 +89,15 @@ module Build
 				end
 			end
 			
+			# @returns [Boolean] whether any tasks have failed during this walk.
 			def failed?
 				@failed_tasks.size > 0
 			end
 			
+			# Block the current fiber until all tasks generating the given paths have completed.
+			# @parameter task [Task] the task waiting on these paths.
+			# @parameter paths [Build::Files::List] the paths to wait on.
+			# @returns [Boolean] true if all paths are available, false if any failed.
 			def wait_on_paths(task, paths)
 				# If there are no paths, we are done:
 				return true if paths.count == 0
@@ -113,13 +110,13 @@ module Build
 				paths.each do |path|
 					# Is there a task generating this output?
 					if outputs = @outputs[path]
-						@logger&.debug(self) {"Task #{task} is waiting on path #{path}"}
+						Console.debug(self){"Task #{task} is waiting on path #{path}"}
 						
 						# When the output is ready, trigger this edge:
 						outputs << edge
 						edge.increment!
 					elsif !File.exist?(path)
-						@logger&.warn(self) {"Task #{task} is waiting on paths which don't exist and are not being generated!"}
+						Console.warn(self){"Task #{task} is waiting on paths which don't exist and are not being generated!"}
 						raise RuntimeError, "File #{path} is not being generated by any active task!"
 						# What should we do about paths which haven't been registered as outputs?
 						# Either they exist - or they don't.
@@ -141,7 +138,7 @@ module Build
 				# If there are no children like this, then done:
 				return true if children.size == 0
 				
-				@logger&.debug(self) {"Task #{parent} is waiting on #{children.count} children"}
+				Console.debug(self){"Task #{parent} is waiting on #{children.count} children"}
 				
 				# Otherwise, construct an edge to track state changes:
 				edge = Edge.new
@@ -160,15 +157,16 @@ module Build
 				return edge.wait
 			end
 			
+			# Register a task as active and record its declared output paths.
+			# @parameter task [Task] the task that is beginning execution.
 			def enter(task)
-				@logger&.debug(self) {"Walker entering: #{task.node}"}
 				
 				@tasks[task.node] = task
 				
 				# In order to wait on outputs, they must be known before entering the task. This might seem odd, but unless we know outputs are being generated, waiting for them to complete is impossible - unless this was somehow specified ahead of time. The implications of this logic is that all tasks must be sequential in terms of output -> input chaning. This is by design and is not a problem in practice.
 				
 				if outputs = task.outputs
-					@logger&.debug(self) do |buffer|
+					Console.debug(self) do |buffer|
 						buffer.puts "Task will generate outputs:"
 						Array(outputs).each do |output|
 							buffer.puts output.inspect
@@ -182,8 +180,9 @@ module Build
 				end
 			end
 			
+			# Mark a task as finished, resolve its output paths and notify any waiting tasks.
+			# @parameter task [Task] the task that has finished execution.
 			def exit(task)
-				@logger&.debug(self) {"Walker exiting: #{task.node}, task #{task.failed? ? 'failed' : 'succeeded'}"}
 				
 				# Fail outputs if the node failed:
 				if task.failed?
@@ -198,7 +197,7 @@ module Build
 				task.outputs.each do |path|
 					path = path.to_s
 					
-					@logger&.debug(self) {"File #{task.failed? ? 'failed' : 'available'}: #{path}"}
+					Console.debug(self){"File #{task.failed? ? 'failed' : 'available'}: #{path}"}
 					
 					if edges = @outputs.delete(path)
 						# @logger&.debug "\tUpdating #{edges.count} edges..."
@@ -214,14 +213,16 @@ module Build
 				@monitor.add(task)
 			end
 			
+			# Remove a node and its associated task from the walker, e.g. after it has been invalidated.
+			# @parameter node [Node] the node to remove.
 			def delete(node)
-				@logger&.debug(self) {"Delete #{node}"}
-
+				
 				if task = @tasks.delete(node)
 					@monitor.delete(task)
 				end
 			end
 			
+			# Remove all failed tasks from the walker so they can be retried on the next update.
 			def clear_failed
 				@failed_tasks.each do |task|
 					self.delete(task.node)
@@ -231,6 +232,7 @@ module Build
 				@failed_outputs = Set.new
 			end
 			
+			# Run an update loop, re-executing the given block whenever the monitor detects filesystem changes.
 			def run(**options)
 				yield
 				
@@ -239,6 +241,7 @@ module Build
 				end
 			end
 			
+			# @returns [String] a human-readable summary of the walker state.
 			def inspect
 				"\#<#{self.class}:0x#{self.object_id.to_s(16)} #{@tasks.count} tasks, #{@failed_tasks.count} failed>"
 			end

data/lib/build/graph.rb

@@ -1,29 +1,10 @@
-# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
 
-require_relative 'graph/task'
-require_relative 'graph/node'
-require_relative 'graph/walker'
-require_relative 'graph/edge'
+# Released under the MIT License.
+# Copyright, 2014-2026, by Samuel Williams.
 
-module Build
-	module Graph
-	end
-end
+require_relative "graph/version"
+require_relative "graph/task"
+require_relative "graph/node"
+require_relative "graph/walker"
+require_relative "graph/edge"

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2014-2026, by Samuel Williams.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,37 @@
+# Build::Graph
+
+Build::Graph is a framework for build systems, with specific functionality for dealing with file based processes.
+
+[![Development Status](https://github.com/ioquatix/build-graph/workflows/Test/badge.svg)](https://github.com/ioquatix/build-graph/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://ioquatix.github.io/build-graph) for more details.
+
+  - [Getting Started](https://ioquatix.github.io/build-graphguides/getting-started/index) - This guide explains how to use `build-graph` to build a dependency graph for file-based build systems.
+
+## Releases
+
+Please see the [project releases](https://ioquatix.github.io/build-graphreleases/index) for all releases.
+
+### v2.2.0
+
+  - Remove `logger` interface.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

data/releases.md

@@ -0,0 +1,5 @@
+# Releases
+
+## v2.2.0
+
+  - Remove `logger` interface.