diff --git a/README.md b/README.md index 4a8594d..28c0f85 100644 --- a/README.md +++ b/README.md @@ -42,28 +42,21 @@ Latest version is `v2.2`. - uses: "actions/checkout@master" - name: "TODO to Issue" uses: "alstr/todo-to-issue-action@v2.2" - with: - REPO: ${{ github.repository }} - BEFORE: ${{ github.event.before }} - SHA: ${{ github.sha }} - TOKEN: ${{ secrets.GITHUB_TOKEN }} - LABEL: "# TODO" - COMMENT_MARKER: "#" id: "todo" **If you use the action in a new repo, you should initialise the repo with an empty commit.** ### Inputs -| Input | Description | -|----------|-------------| -| `REPO` | The path to the repository where the action will be used, e.g. 'alstr/my-repo' (automatically set) | -| `BEFORE` | The SHA of the last pushed commit (automatically set) | -| `SHA` | The SHA of the latest commit (automatically set) | -| `TOKEN` | The GitHub access token to allow us to retrieve, create and update issues (automatically set) | -| `LABEL` | The label that will be used to identify TODO comments (e.g. `# TODO` for Python) | -| `COMMENT_MARKER` | The marker used to signify a line comment in your code (e.g. `#` for Python) | -| `CLOSE_ISSUES` | Optional input that specifies whether to attempt to close an issue when a TODO is removed (default: "true") | +| Input | Default value | Description | +|----------|---------------|-------------| +| `REPO` | "${{ github.repository }}" | The path to the repository where the action will be used, e.g. 'alstr/my-repo' (automatically set) | +| `BEFORE` | "${{ github.event.before }}" | The SHA of the last pushed commit (automatically set) | +| `SHA` | "${{ github.sha }}" | The SHA of the latest commit (automatically set) | +| `TOKEN` | "${{ secrets.GITHUB_TOKEN }}" | The GitHub access token to allow us to retrieve, create and update issues (automatically set) | +| `LABEL` | "# TODO" | The label that will be used to identify TODO comments (e.g. `# TODO` for Python) | +| `COMMENT_MARKER` | "#" | The marker used to signify a line comment in your code (e.g. `#` for Python) | +| `CLOSE_ISSUES` | "true" | Optional input that specifies whether to attempt to close an issue when a TODO is removed | ## Examples diff --git a/action.yml b/action.yml index dc89843..28f2d07 100644 --- a/action.yml +++ b/action.yml @@ -11,21 +11,28 @@ inputs: REPO: description: "The path to the repository where the action will be used, e.g. 'alstr/my-repo' (automatically set)" required: true + default: "${{ github.repository }}" BEFORE: description: "The SHA of the last pushed commit (automatically set)" required: true + default: "${{ github.event.before }}" SHA: description: "The SHA of the latest commit (automatically set)" required: true + default: "${{ github.sha }}" TOKEN: description: "The GitHub access token to allow us to retrieve, create and update issues (automatically set)" required: true + default: "${{ secrets.GITHUB_TOKEN }}" LABEL: description: "The label that will be used to identify TODO comments (e.g. # TODO for Python)" required: true + default: "# TODO" COMMENT_MARKER: description: "The marker used to signify a line comment in your code (e.g. # for Python)" required: true + default: "#" CLOSE_ISSUES: description: "Optional input that specifies whether to attempt to close an issue when a TODO is removed (default: true)" required: false + default: "true" diff --git a/main.py b/main.py index 060cedc..cb4e304 100644 --- a/main.py +++ b/main.py @@ -20,7 +20,7 @@ def main(): comment_marker = os.getenv('INPUT_COMMENT_MARKER') label = os.getenv('INPUT_LABEL') token = os.getenv('INPUT_TOKEN') - close_issues = os.getenv('INPUT_CLOSE_ISSUES', 'true') == 'true' + close_issues = os.getenv('INPUT_CLOSE_ISSUES') # Load a file so we can see what language each file is written in and apply highlighting later. languages_url = 'https://raw.githubusercontent.com/github/linguist/master/lib/linguist/languages.yml'