@@ -15,6 +15,13 @@ If this GitHub Action helps your team, please consider supporting its developmen
1515
1616** [ Sponsor on GitHub] ( https://github.com/sponsors/Devlander-Software ) ** - Monthly recurring support
1717
18+ ** Connect with us:**
19+ - [ Discord] ( https://bit.ly/devlander-discord-invite ) - Join our community
20+ - [ Twitter] ( https://twitter.com/devlanderjs ) - Follow for updates
21+ - [ Instagram] ( https://instagram.com/devlander.js ) - Behind the scenes
22+ - [ Facebook] ( https://www.facebook.com/devlanderjs ) - Stay connected
23+ - [ YouTube] ( https://www.youtube.com/@devlanderjs ) - Tutorials & demos
24+
1825Your sponsorship helps us:
1926- Maintain and improve the action
2027- Add new features and integrations
@@ -49,123 +56,19 @@ Your sponsorship helps us:
4956
5057## Quick Installation
5158
52- ### Method 1: GitHub Actions (Recommended)
59+ ### GitHub Marketplace (Recommended)
5360
54- Create a new workflow file in your repository:
61+ Add this simple workflow to your repository:
5562
5663``` yaml
5764# .github/workflows/auto-label-issues.yml
58- name : Setup Issue Templates and Labels
65+ name : Auto Label Issues & Templates
5966
6067on :
6168 issues :
6269 types : [opened, edited]
6370 pull_request :
6471 types : [opened, edited, synchronize]
65- repository_dispatch :
66- types : [create_labels, cleanup, update]
67-
68- env :
69- CREATE_TEMPLATES : ${{ vars.CREATE_TEMPLATES || 'true' }}
70- CREATE_LABELS : ${{ vars.CREATE_LABELS || 'true' }}
71- AUTO_LABEL_ISSUES : ${{ vars.AUTO_LABEL_ISSUES || 'true' }}
72- RATE_LIMIT_DELAY : ${{ vars.RATE_LIMIT_DELAY || '0.5' }}
73- MAX_RETRIES : ${{ vars.MAX_RETRIES || '3' }}
74-
75- jobs :
76- create_issue_templates :
77- runs-on : ubuntu-latest
78- if : ${{ vars.CREATE_TEMPLATES != 'false' }}
79- steps :
80- - uses : actions/checkout@v3
81- - uses : actions/setup-node@v3
82- with :
83- node-version : ' 18'
84- cache : ' npm'
85- - run : npm ci
86- - run : npm run generate:templates
87- - run : |
88- git config --global user.email "[email protected] " 89- git config --global user.name "GitHub Action"
90- git add .github/ISSUE_TEMPLATE/*.md
91- git commit -m "Generate issue templates from config"
92- git push
93- env:
94- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
95-
96- create_labels :
97- runs-on : ubuntu-latest
98- needs : create_issue_templates
99- if : ${{ vars.CREATE_LABELS != 'false' }}
100- steps :
101- - uses : actions/checkout@v3
102- - run : |
103- # Download and run the complete workflow
104- curl -sSL https://raw.githubusercontent.com/Devlander-Software/issue-labler/production/.github/workflows/auto-label-issues.yml | bash
105- env:
106- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
107-
108- label-by-files :
109- runs-on : ubuntu-latest
110- needs : create_labels
111- if : ${{ vars.AUTO_LABEL_ISSUES != 'false' && github.event_name == 'pull_request' }}
112- steps :
113- - uses : actions/checkout@v3
114- with :
115- fetch-depth : 0
116- - run : |
117- # Download and run the complete workflow
118- curl -sSL https://raw.githubusercontent.com/Devlander-Software/issue-labler/production/.github/workflows/auto-label-issues.yml | bash
119- env:
120- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
121-
122- label-issue :
123- runs-on : ubuntu-latest
124- needs : create_labels
125- if : ${{ vars.AUTO_LABEL_ISSUES != 'false' && github.event_name == 'issues' }}
126- steps :
127- - uses : actions/checkout@v3
128- - run : |
129- # Download and run the complete workflow
130- curl -sSL https://raw.githubusercontent.com/Devlander-Software/issue-labler/production/.github/workflows/auto-label-issues.yml | bash
131- env:
132- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
133- ` ` `
134-
135- ### Method 2: One-Line Install Script
136-
137- ` ` ` bash
138- # Run this in your repository root
139- curl -sSL https://raw.githubusercontent.com/Devlander-Software/issue-labler/production/install.sh | bash
140- ```
141-
142- This downloads the complete workflow file and sets it up automatically.
143-
144- ### Method 3: Manual Download
145-
146- ``` bash
147- # 1. Create workflows directory
148- mkdir -p .github/workflows
149-
150- # 2. Download the workflow file
151- curl -o .github/workflows/auto-label-issues.yml \
152- https://raw.githubusercontent.com/Devlander-Software/issue-labler/production/.github/workflows/auto-label-issues.yml
153-
154- # 3. Commit and push
155- git add .github/workflows/auto-label-issues.yml
156- git commit -m " Add auto-label issues workflow"
157- git push
158- ```
159-
160- ### Method 4: GitHub Marketplace (Future)
161-
162- Once published to GitHub Marketplace, you can use it as a reusable action:
163-
164- ``` yaml
165- name : Auto Label Issues
166- on :
167- issues : [opened, edited]
168- pull_request : [opened, edited, synchronize]
16972
17073jobs :
17174 auto-label :
@@ -174,9 +77,16 @@ jobs:
17477 - uses : actions/checkout@v3
17578 - uses : Devlander-Software/issue-labler@v1
17679 with :
177- github_token : ${{ secrets.GITHUB_TOKEN }}
80+ create_templates : ' true'
81+ create_labels : ' true'
82+ auto_label_issues : ' true'
17883` ` `
17984
85+ That's it! The action will automatically:
86+ - Create professional issue templates
87+ - Set up 50+ comprehensive labels
88+ - Auto-label issues and PRs based on content and file changes
89+
18090## Test Your Installation
18191
18292After installation, test it by creating an issue with:
0 commit comments