Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 6, 2025

This PR adds a complete .github/copilot-instructions.md file that provides GitHub Copilot coding agents with comprehensive instructions for working effectively in the Sentrius codebase.

What's Included

The instructions file provides validated, copy-paste commands for:

Build & Test Operations with measured timings:

  • Maven build: mvn clean install (7m24s initial, 31s cached)
  • Test execution: mvn test (1m3s consistently)
  • Python agent setup and validation
  • Helm chart linting and template rendering

Infrastructure Requirements clearly documented:

  • Required: PostgreSQL, Keycloak, OpenTelemetry
  • Optional: Neo4j, Kafka, Kubernetes cluster
  • Exact connection strings and default ports

Technology Stack with version requirements:

  • Java 17, Maven 3.6+, Spring Boot 3.4.x
  • Python 3.12+ for agent framework
  • Docker, kubectl, helm for deployment

Critical Timeout Settings to prevent premature cancellation:

  • Build operations: 60+ minute timeouts
  • Test execution: 30+ minute timeouts
  • Explicit "NEVER CANCEL" warnings for long-running operations

Validation Process

Every command and instruction was thoroughly validated:

  • ✅ Complete Maven build executed and timed
  • ✅ All tests run successfully
  • ✅ Python agent framework tested in isolation
  • ✅ Helm charts validated and templates rendered
  • ✅ Known Maven warnings documented as expected

The instructions follow an imperative tone ("Run this command", "Set timeout to 60+ minutes") and include troubleshooting sections for common issues like dependency conflicts and infrastructure requirements.

This ensures any GitHub Copilot agent can follow these instructions and have commands work reliably without requiring additional context gathering or trial-and-error.

Fixes #89.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • repository.jboss.org
    • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.11/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.11/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.11 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.11/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/Sentrius/Sentrius org.codehaus.plexus.classworlds.launcher.Launcher clean install -DskipTests (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

… and timeouts

Co-authored-by: phrocker <1781585+phrocker@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨Set up Copilot instructions Add comprehensive GitHub Copilot instructions for development workflow Aug 6, 2025
Copilot AI requested a review from phrocker August 6, 2025 19:28
@phrocker phrocker marked this pull request as ready for review August 6, 2025 19:35
@phrocker phrocker merged commit 39db4ab into main Aug 7, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨Set up Copilot instructions

2 participants