Skip to content

Add comprehensive GitHub Copilot instructions for PyPI publish action development #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: unstable/v1
Choose a base branch
from

Conversation

Copilot
Copy link

@Copilot Copilot AI commented Aug 7, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed guidance for working effectively in this Docker-based GitHub Action repository.

What's Included

The instructions provide complete guidance covering:

Bootstrap and Validation Commands

  • All commands have been tested and validated to work in the current environment
  • Includes fallback manual validation for network-restricted environments
  • Python syntax validation, shell script checking, and YAML validation

Build Process Documentation

  • Docker build process with exact timing expectations (10-20 minutes, 30+ minute timeout)
  • Smoke test execution (2 minutes, 5+ minute timeout)
  • Clear "NEVER CANCEL" warnings for long-running operations

Manual Validation Scenarios

  • Step-by-step testing procedures for Python scripts, shell scripts, and action definitions
  • Functional testing scenarios for hash calculation and package name extraction
  • Security considerations for credential handling

Comprehensive Troubleshooting

  • Documents known network limitations in sandboxed environments
  • Provides workarounds when automated tools fail due to SSL/connectivity issues
  • Explains why Docker builds and pip installations may fail in restricted environments

Repository Structure Guide

  • Detailed explanation of key files and their purposes
  • Dependencies and requirements management with pip-tools
  • Development best practices and validation workflows

Key Features

  • Firm directive to always reference instructions first before searching or using bash commands
  • Exhaustively validated - every documented command has been tested to work correctly
  • Handles limitations - provides manual alternatives when network restrictions prevent automated tools
  • Security-aware - includes guidance for handling sensitive credentials and OIDC flows
  • Developer-friendly - structured for quick reference and efficient workflow

The instructions enable any developer to quickly understand this codebase and work effectively while navigating the common challenges of sandboxed development environments.

Fixes #374.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@Copilot Copilot AI changed the title [WIP] ✨Set up Copilot instructions Add comprehensive GitHub Copilot instructions for PyPI publish action development Aug 7, 2025
@webknjaz
Copy link
Member

webknjaz commented Aug 7, 2025

pre-commit.ci autofix

Copilot finished work on behalf of webknjaz August 7, 2025 12:23
.gitignore Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot revert changes to this file.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted the .gitignore changes as requested in commit 088da53.

@Copilot Copilot AI requested a review from webknjaz August 7, 2025 12:27
Copilot finished work on behalf of webknjaz August 7, 2025 12:27
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