README.md

Issue Sentinel

Easily connect to the smart Issue Sentinel with this GitHub Action. It helps you handle similar issues and security issues in your repository efficiently.

Use the Issue Sentinel

To use the Issue Sentinel, follow these steps:

1. Contact AzPyCLI@microsoft.com to get the permission for the Sentinel. We will assist you with onboarding and add your repository to the database.

2. Add the following workflow in your repository.

   #File: .github/workflows/RunIssueSentinel.yml
   name: Run issue sentinel
   on:
     issues:
       types: [opened, edited, closed]
   
   jobs:
     Issue:
       permissions:
         issues: write
       runs-on: ubuntu-latest
       steps:
         - name: Run Issue Sentinel
           uses: Azure/issue-sentinel@v1
           with:
             enable-similar-issues-scanning: true # Scan similar issues in your repo, default: true
             enable-security-issues-scanning: true # Scan security issues in your repo, default: false
             enable-ux-tag: false # Add UX tags to issues (currently only designed for azure-cli), default: false

Notes for developers

To build the action, use the following commands:

1. npm install

2. npm run build

Used by

• Azure CLI
• Azure PowerShell
• Office JS
• Microsoft Authentication Library (MSAL) for Python
• Microsoft Authentication Library (MSAL) for .NET