Add AGENTS.md - #261
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an AGENTS.md guide intended to help automated agents (and contributors) understand the repo’s Docker-based workflow architecture and the expected way to build/test apps.
Changes:
- Introduces
AGENTS.mddescribing repository layout (apps/,base/docker/) and Docker Compose–orchestrated testing. - Documents how
apps/<workflow-name>/test.shruns builds, seeds data, executes workflows, and runs pytest inside containers. - Captures practical conventions around service dependencies, env vars, and log locations.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
Author
|
Docker images for version v2026.7.0 were built and pushed after this PR was merged. View workflow run |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds a new
AGENTS.mddocumentation file, providing clear instructions and architectural guidance for working with ApertureDB workflows in this repository. The documentation outlines the project structure, testing and build processes, and important conventions for contributors.Documentation additions:
AGENTS.mdto explain the repository's architecture, including the organization of workflow applications inapps/, use of a shared base Docker image, and the role of supporting services likeaperturedbandlenz.test.shorchestrates builds and tests, and where to find test logs.