Skip to content

Commit cd6df54

Browse files
Copilotmikebarkmin
andcommitted
Update Copilot instructions - build now works with jogamp.org allowed
Co-authored-by: mikebarkmin <2592379+mikebarkmin@users.noreply.github.com>
1 parent 1aef32e commit cd6df54

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

.github/copilot-instructions.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,25 +33,23 @@ The library is structured around three core concepts:
3333

3434
### Maven Build Commands
3535

36-
⚠️ **CRITICAL DEPENDENCY ISSUE**: The build currently fails due to network connectivity issues with the jogamp repository (jogamp.org). This is a known external issue.
37-
38-
**Standard Build Attempts (Currently Failing)**:
36+
**Standard Build Commands**:
3937
```bash
40-
mvn clean compile # FAILS - jogamp dependency issue
41-
mvn clean package # FAILS - jogamp dependency issue
38+
mvn clean compile # Basic compilation
39+
mvn clean package # Create standard JAR
40+
mvn clean test # Run tests (if any)
4241
```
4342

44-
**Working Build Profiles**:
43+
**Build Profiles**:
4544
```bash
4645
# For Maven Central release (includes native dependencies)
47-
mvn clean compile -Pcentral # May work in some environments
46+
mvn clean compile -Pcentral
4847

4948
# For standalone JAR with all dependencies
5049
mvn clean package -Pall # Creates target/*-all.jar
5150
```
5251

53-
### Build Workarounds
54-
When jogamp repository is unavailable, the build will fail. This is a known issue and not related to code changes. The library uses JOGL for OpenGL graphics rendering.
52+
**Note**: The library uses JOGL for OpenGL graphics rendering, which requires access to the jogamp.org repository. This dependency is now working correctly in the CI environment.
5553

5654
### Documentation Build
5755

@@ -140,7 +138,7 @@ src/
140138
### Validation Steps
141139
1. **Documentation Coverage**: Run `./s4j` to ensure all public APIs are documented
142140
2. **Example Compilation**: All reference examples should compile successfully
143-
3. **Maven Build**: Should pass when jogamp repository is accessible
141+
3. **Maven Build**: Standard build commands work with all profiles
144142
4. **Documentation Build**: `npx hyperbook build` should complete successfully
145143

146144
## Templates and Starter Projects
@@ -215,9 +213,9 @@ The repository includes VS Code configuration with:
215213
## Troubleshooting Common Issues
216214

217215
### Build Failures
218-
1. **jogamp.org dependency errors**: External repository issue, not code-related
216+
1. **Maven cache issues**: Run `mvn clean` and retry
219217
2. **Java version mismatch**: Ensure Java 17+ is installed and active
220-
3. **Maven cache issues**: Run `mvn clean` and retry
218+
3. **Dependency download issues**: Check network connectivity and retry
221219

222220
### Documentation Issues
223221
1. **Missing documentation warnings**: Run `./s4j --create` to generate templates
@@ -228,7 +226,7 @@ Examples in `src/examples/java/` should compile with the main source. They're in
228226

229227
## Working with This Repository
230228

231-
**ALWAYS** trust these instructions and refer to them before exploring. The build system has known external dependencies that may fail intermittently. Focus on:
229+
**ALWAYS** trust these instructions and refer to them before exploring. Focus on:
232230

233231
1. Understanding the core Sprite/Stage/Window architecture
234232
2. Using the reference examples in `src/examples/java/reference/` as patterns
@@ -237,6 +235,6 @@ Examples in `src/examples/java/` should compile with the main source. They're in
237235

238236
When making changes, ensure:
239237
- All public APIs have corresponding documentation
240-
- Examples compile successfully (when dependencies are available)
238+
- Examples compile successfully
241239
- Changes follow the established patterns in existing code
242240
- Documentation is updated in both English and German if adding new features

0 commit comments

Comments
 (0)