Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 7, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot with detailed instructions for working effectively in the orionrobots.github.io codebase using Docker Compose as the primary development method.

What's Included

The instructions cover the complete Docker-first development workflow with validated commands and timing expectations:

Docker Compose Workflow

  • Primary method: docker compose up for full development server (~4-5 minutes initial build)
  • Manual builds: docker compose run dist (~30 seconds) and docker compose run build (~3 minutes)
  • Testing: docker compose run test for containerized BDD tests
  • Alternative native commands: npm-based workflow as fallback option

Site Configuration

  • Hosting: Correctly identified as 3rd party hosting (not GitHub Pages-style)
  • Technology stack: Fully migrated to Eleventy (11ty) from Jekyll
  • Build pipeline: Webpack + Eleventy with Docker containerization

Comprehensive Coverage

  • Proper timeout recommendations for long-running Docker builds
  • Manual validation scenarios matching CI staging tests
  • Repository structure and Jekyll-to-Eleventy migration context
  • Troubleshooting workflows for both Docker and native environments
  • Apache hosting configuration details

Development Safety

All commands include proper timeout recommendations with "NEVER CANCEL" warnings for long-running builds. Every timing estimate is based on actual Docker Compose performance testing.

The instructions follow the imperative tone requirement and provide exhaustive guidance to minimize incorrect commands while establishing Docker Compose as the intended primary development workflow.

Fixes #248.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: dannystaple <426859+dannystaple@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] ✨Set up Copilot instructions Add comprehensive GitHub Copilot instructions for development workflow Aug 7, 2025
Copilot finished work on behalf of dannystaple August 7, 2025 21:03
@Copilot Copilot AI requested a review from dannystaple August 7, 2025 21:03
@dannystaple
Copy link
Member

The updated branch should fix the docker compose 7 minute issue (staging shouldn't automatically start with docker compose up).
This repo is absolutely intended for use in a docker/docker compose environment - the instructions to the contrary should be removed.

The critical known issues should be fixed, but docker compose is what I have used for some time and should be the go to method.

Copy link
Contributor

github-actions bot commented Aug 7, 2025

🦙 MegaLinter status: ❌ ERROR

Descriptor Linter Files Fixed Errors Warnings Elapsed time
❌ ACTION actionlint 5 6 0 0.09s
✅ BASH bash-exec 1 0 0 0.0s
✅ BASH shellcheck 1 0 0 0.06s
⚠️ BASH shfmt 1 1 0 0.0s
❌ C cppcheck 8 8 0 0.21s
❌ CPP cppcheck 8 8 0 0.21s
✅ JSON npm-package-json-lint yes no no 0.4s
✅ JSON v8r 12 0 0 5.95s
❌ MARKDOWN markdown-link-check 737 213 0 42.73s
✅ REPOSITORY gitleaks yes no no 14.5s
✅ REPOSITORY git_diff yes no no 0.79s
✅ REPOSITORY grype yes no no 34.08s
✅ REPOSITORY secretlint yes no no 42.77s
✅ REPOSITORY syft yes no no 1.56s
✅ REPOSITORY trivy-sbom yes no no 3.47s
✅ REPOSITORY trufflehog yes no no 4.7s
✅ XML xmllint 1 0 0 192.72s
✅ YAML v8r 13 0 0 6.42s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

@dannystaple dannystaple removed their assignment Aug 8, 2025
@dannystaple
Copy link
Member

@copilot can you address the comments here for me please?

…lopment method

Co-authored-by: dannystaple <426859+dannystaple@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Aug 8, 2025

The updated branch should fix the docker compose 7 minute issue (staging shouldn't automatically start with docker compose up).
This repo is absolutely intended for use in a docker/docker compose env...

Updated the instructions to reflect Docker Compose as the intended primary development method. Removed all warnings about Docker being broken and provided proper Docker Compose commands with timing expectations. Native npm commands are now documented as alternatives (c75435d).

@copilot can you address the comments here for me please?

All comments have been addressed - updated site description, corrected Docker Compose as primary development method, and removed outdated Docker warnings (c75435d).

@Copilot Copilot AI changed the title Add comprehensive GitHub Copilot instructions for development workflow Add comprehensive GitHub Copilot instructions with Docker Compose workflow Aug 8, 2025
Copilot finished work on behalf of dannystaple August 8, 2025 07:42
@Copilot Copilot AI requested a review from dannystaple August 8, 2025 07:42
@dannystaple dannystaple marked this pull request as ready for review August 8, 2025 13:31
@dannystaple dannystaple merged commit 63b459b into master Aug 8, 2025
2 checks passed
@dannystaple dannystaple deleted the copilot/fix-248 branch August 8, 2025 13:36
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