Skip to content

Add limit input docs #173

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 3, 2025
+7 −1
Merged

Add limit input docs #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ jobs:
uses: ./
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
limit: 5
```
## 📝 Example TODOs
Expand Down Expand Up @@ -73,7 +74,7 @@ If a label like `priority:high` or `due:2025-06-01` doesn't exist, it will be au

## 📌 Notes

- Max **5 issues** are created per run to avoid rate limiting
- Max **5 issues** are created per run to avoid rate limiting (configurable via the `limit` input)
- **Duplicate detection** is not yet implemented _(coming soon)_
- All labels are **auto-created with default colors** if missing

Expand Down
5 changes: 5 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ inputs:
required: false
description: Email used in conjunction with the Jira API token

limit:
required: false
description: Maximum number of issues to create
default: '5'

runs:
using: 'node20'
main: 'dist/index.js'
Expand Down