diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index be83c18d0..093db174a 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -10,6 +10,8 @@ # Windows Implementation Library submodule /wil/ @microsoft/driver-samples-maintainers +# Samples + # Audio /audio/ @microsoft/windowsaudio diff --git a/.github/ISSUE_TEMPLATE/sample_issue.yml b/.github/ISSUE_TEMPLATE/sample_issue.yml new file mode 100644 index 000000000..4597086a5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/sample_issue.yml @@ -0,0 +1,75 @@ +name: Issue with a sample +description: Report a problem you have with a specific sample. +title: '[path/to/sample]: ' +body: +- type: dropdown + id: sample_area + attributes: + label: Which is the area where the sample lives? + description: Select the area where you're experiencing the problem. + options: + - /TrEE/ + - /audio/ + - /avstream/ + - /bluetooth/ + - /filesys/cdfs/ + - /filesys/fastfat/ + - /filesys/miniFilter/ + - /general/DCHU/ + - /general/PLX9x5x/ + - /general/SimpleMediaSource/ + - /general/SystemDma/ + - /general/cancel/ + - /general/echo/ + - /general/event/ + - /general/ioctl/ + - /general/pcidrv/ + - /general/perfcounters/ + - /general/registry/ + - /general/toaster/ + - /general/tracing/ + - /gnss/ + - /gpio/ + - /hid/ + - /input/ + - /network/config/ + - /network/modem/ + - /network/ndis/ + - /network/radio/ + - /network/trans/ + - /network/wlan/ + - /network/wsk/ + - /network/wwan/ + - /nfc/ + - /pofx/PEP/ + - /pofx/UMDF2/ + - /pofx/WDF/ + - /pos/ + - /powerlimit/ + - /print/ + - /prm/ + - /sd/ + - /security/ + - /sensors/ + - /serial/ + - /setup/ + - /simbatt/ + - /smartcrd/ + - /spb/ + - /storage/ + - /thermal/ + - /tools/ + - /usb/ + - /video/ + - /wia/ + - /wmi/wmiacpi/ + - /wmi/wmisamp/ + validations: + required: true +- type: textarea + id: description + attributes: + label: Describe the issue + description: Provide a clear and concise description of what the issue is. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/sample_issue_generator.py b/.github/ISSUE_TEMPLATE/sample_issue_generator.py new file mode 100644 index 000000000..4b6eee640 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/sample_issue_generator.py @@ -0,0 +1,72 @@ +import yaml +import os + +# Read the CODEOWNERS file +codeowners_path = os.path.join(os.path.dirname(__file__), "..", "CODEOWNERS") +with open(codeowners_path, "r") as file: + lines = file.readlines() + +# Parse the CODEOWNERS file to extract areas and their paths +areas = [] +sample_section_found = False + +for line in lines: + line = line.strip() + if line.startswith("# Samples"): + sample_section_found = True + continue + + if sample_section_found: + if line.startswith("#"): + continue + elif line: + path, codeowner = line.split() + if path in areas: + raise ValueError(f"Path:{path} has been found two times inside CODEOWNERS file") + areas.append(path) + + +# Sort the areas in lexicographical order +areas = sorted(areas) + +# Generate the YAML structure +yaml_form = { + "name": "Issue with a sample", + "description": "Report a problem you have with a specific sample.", + "title": "[path/to/sample]: ", + "body": [] +} + +dropdown = { + "type": "dropdown", + "id": "sample_area", + "attributes": { + "label": "Which is the area where the sample lives?", + "description": "Select the area where you're experiencing the problem.", + "options": areas + }, + "validations": { + "required": True + } +} + +# Add a description field +description_field = { + "type": "textarea", + "id": "description", + "attributes": { + "label": "Describe the issue", + "description": "Provide a clear and concise description of what the issue is." + }, + "validations": { + "required": True + } +} + +yaml_form["body"].append(dropdown) +yaml_form["body"].append(description_field) + +# Write the YAML to a file +output_path = os.path.join(os.path.dirname(__file__), "sample_issue.yml") +with open(output_path, "w") as outfile: + yaml.dump(yaml_form, outfile, sort_keys=False) diff --git a/.github/workflows/check-sample-issue-template.yml b/.github/workflows/check-sample-issue-template.yml new file mode 100644 index 000000000..28534e92a --- /dev/null +++ b/.github/workflows/check-sample-issue-template.yml @@ -0,0 +1,49 @@ +name: Check Sample Issue Template + +on: + pull_request: + paths: + - '.github/CODEOWNERS' + - '.github/ISSUE_TEMPLATE/sample_issue.yml' + + +jobs: + generate-template: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.x' + + - name: Install dependencies + run: pip install pyyaml + + - name: Run the generator script + run: python .github/ISSUE_TEMPLATE/sample_issue_generator.py + + - name: Check for discrepancies + run: | + if git diff --quiet .github/ISSUE_TEMPLATE/sample_issue.yml; then + echo "✅ No discrepancies found. The sample issue template is up to date." + else + echo "❌ Discrepancy detected!" + echo "The CODEOWNERS file was modified, but the sample issue template is not up to date." + echo "" + echo "Please regenerate the sample issue template by running:" + echo " python .github/ISSUE_TEMPLATE/sample_issue_generator.py" + echo "" + echo "Or manually update it." + echo "" + echo "Then commit both files together:" + echo " git add .github/CODEOWNERS .github/ISSUE_TEMPLATE/sample_issue.yml" + echo " git commit -m 'Update CODEOWNERS and regenerate sample issue template'" + echo "" + echo "Differences found:" + git diff .github/ISSUE_TEMPLATE/sample_issue.yml + exit 1 + fi diff --git a/.github/workflows/tag-codeowner-on-issue.yml b/.github/workflows/tag-codeowner-on-issue.yml new file mode 100644 index 000000000..ec7524ac1 --- /dev/null +++ b/.github/workflows/tag-codeowner-on-issue.yml @@ -0,0 +1,79 @@ +name: Tag Codeowner on Sample Issue + +on: + issues: + types: [opened] + +jobs: + tag-codeowner: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.x' + + - name: Install dependencies + run: pip install pyyaml requests + + - name: Extract selected path and tag codeowner + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + python3 - <