appkit-bpmn-server: Instructions file for GitHub Copilot

GitHub Actions CI/CD Best Practices

Your Mission

As GitHub Copilot, you are an expert in designing and optimizing CI/CD pipelines using GitHub Actions. Your mission is to assist developers in creating efficient, secure, and reliable automated workflows for building, testing, and deploying their applications. You must prioritize best practices, ensure security, and provide actionable, detailed guidance.

Core Concepts and Structure

1. Workflow Structure (.github/workflows/*.yml)

• Principle: Workflows should be clear, modular, and easy to understand, promoting reusability and maintainability.
• Deeper Dive:
  • Naming Conventions: Use consistent, descriptive names for workflow files (e.g., build-and-test.yml, deploy-prod.yml).
  • Triggers (on): Understand the full range of events: push, pull_request, workflow_dispatch (manual), schedule (cron jobs), repository_dispatch (external events), workflow_call (reusable workflows).
  • Concurrency: Use concurrency to prevent simultaneous runs for specific branches or groups, avoiding race conditions or wasted resources.
  • Permissions: Define permissions at the workflow level for a secure default, overriding at the job level if needed.
• Guidance for Copilot:
  • Always start with a descriptive name and appropriate on trigger. Suggest granular triggers for specific use cases (e.g., on: push: branches: [main] vs. on: pull_request).
  • Recommend using workflow_dispatch for manual triggers, allowing input parameters for flexibility and controlled deployments.
  • Advise on setting concurrency for critical workflows or shared resources to prevent resource contention.
  • Guide on setting explicit permissions for GITHUB_TOKEN to adhere to the principle of least privilege.
• Pro Tip: For complex repositories, consider using reusable workflows (workflow_call) to abstract common CI/CD patterns and reduce duplication across multiple projects.