fix(action): fix and refactor the action set-date-closed-field-v1 (#327)

This pull request enhances the GitHub Action for setting a closed date
field on issues by generalizing support for any date-type project field
(not just `DateClosed`), improving documentation, and adding robust test
coverage for new and existing utility functions. The action is now more
flexible and maintainable, with clearer error messages and better user
guidance.

Tested in my test repo:
- incorrect field -
[failed](https://github.com/dequelabs/maksym-testing/actions/runs/23591546329)
- issue not found -
[failed](https://github.com/dequelabs/maksym-testing/actions/runs/23591574850)
- issue is in another project -
[success](https://github.com/dequelabs/maksym-testing/actions/runs/23591631450/job/68698046620)
- set closed date -
[success](https://github.com/dequelabs/maksym-testing/actions/runs/23591693601/job/68698254745)

Closes: #319

Author: maksym-shynkarenko

.github/actions/set-date-closed-field-v1/README.md

@@ -1,30 +1,32 @@
-# Set DateClosed Field on Issue Close Action
+# Set Closed Date Field on Issue Close Action
 
-This action updates the `DateClosed` project field when an issue is closed as completed. If an issue is reopened and closed again, the `DateClosed` field will reflect the latest date that it was closed.
+This action updates a date project field (default: `DateClosed`) when an issue is closed as completed. If an issue is reopened and closed again, the field will reflect the latest date that it was closed.
 
 ## Quick Reference
 
-| Input                | Description                                   | Required | Default |
-| -------------------- | --------------------------------------------- | -------- | ------- |
-| `issue-number`       | The issue number to check                     | Yes      | -       |
-| `issue-organization` | The organization where the issue is located   | No       | -       |
-| `issue-repo`         | The repository where the issue is located     | No       | -       |
-| `project-number`     | The project number where the issue is located | Yes      | -       |
+| Input                | Description                                               | Required | Default      |
+| -------------------- | --------------------------------------------------------- | -------- | ------------ |
+| `token`              | PAT with required permissions (see below)                 | Yes      | -            |
+| `issue-number`       | The issue number to check                                 | Yes      | -            |
+| `issue-organization` | The organization where the issue is located               | No       | -            |
+| `issue-repo`         | The repository where the issue is located                 | No       | -            |
+| `project-number`     | The project number where the issue is located             | Yes      | -            |
+| `date-field-name`    | The name of the date field to update the issue close date | No       | `DateClosed` |
 
 **Requirements:**
 
-- Custom `DateClosed` field (Date type) in your project
-- `GH_TOKEN` environment variable set to a Personal Access Token with `repo`, `read:org`, `write:org`, and `project` scopes
+- A custom date field (Date type) in your project (default name: `DateClosed`)
+- A Personal Access Token with `repo`, `read:org`, `write:org`, and `project` scopes
 - Issue must be added to the specified project board
 
 ## Setup
 
-### 1. Create the DateClosed Custom Field
+### 1. Create the Date Custom Field
 
 1. Navigate to your GitHub project board
 2. Click the "+" icon to add a new field
 3. Select "Custom field"
-4. Name the field `DateClosed` and set type to **Date**
+4. Name the field `DateClosed` (or your preferred name) and set type to **Date**
 5. Save the field
 
 ### 2. Create Personal Access Token
@@ -42,8 +44,6 @@ This action updates the `DateClosed` project field when an issue is closed as co
 3. Name: `PAT`, Value: your token
 4. Click "Add secret"
 
-**Note**: The action now uses the `GH_TOKEN` environment variable instead of a token input parameter.
-
 ### 4. Find Your Project Number
 
 **From GitHub UI:** Look at your project URL: `https://github.com/orgs/YOUR_ORG/projects/PROJECT_NUMBER`
@@ -57,7 +57,7 @@ gh project list --owner YOUR_ORG_OR_USERNAME
 ## Usage
 
 ```yaml
-name: Set DateClosed Field on Issue Close
+name: Set Closed Date Field on Issue Close Action
 
 on:
   issues:
@@ -71,16 +71,15 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Set DateClosed Field on Issue Close
+      - name: Set closed date field
         uses: dequelabs/axe-api-team-public/.github/actions/set-date-closed-field-v1@main
         with:
           issue-number: ${{ github.event.issue.number }}
           issue-organization: ${{ github.event.repository.owner.login }}
           issue-repo: ${{ github.event.repository.name }}
           project-number: '123' # Replace with your project number
+          date-field-name: 'MyCustomDateField'
           token: ${{ secrets.PAT }}
-        env:
-          GH_TOKEN: ${{ secrets.PAT }}
 ```
 
 **Important:** The default `GITHUB_TOKEN` will not work for project operations. You must use a PAT as shown above.
@@ -90,37 +89,27 @@ jobs:
 1. **Issue Check** - Gets the issue details using the provided parameters
 2. **Closed Status Check** - Verifies the issue is closed and has a `closed_at` date
 3. **Project Item Lookup** - Finds the issue in the specified project board
-4. **DateClosed Field Update** - Updates the `DateClosed` field with the close date in YYYY-MM-DD format
+4. **Date Field Update** - Updates the specified date field (default: `DateClosed`) with the close date in YYYY-MM-DD format
 5. **Re-closing Support** - If an issue is reopened and closed again, the field reflects the latest close date
 
 ## Troubleshooting
 
-### "Failed to get DateClosed field ID"
+### "Failed to get \<field name\> field ID"
 
 **Causes:**
 
 - Incorrect project number
-- DateClosed field doesn't exist in the project
+- The specified date field doesn't exist in the project
 - Token lacks project access
 - Project is in a different organization
 
 **Solutions:**
 
 1. Verify project number using: `gh project list --owner YOUR_ORG`
-2. Check if DateClosed field exists: `gh project field-list PROJECT_NUMBER --owner YOUR_ORG --format json`
+2. Check if the field exists: `gh project field-list PROJECT_NUMBER --owner YOUR_ORG --format json`
 3. Ensure PAT has all required scopes
 4. Confirm project organization matches your expectations
 
-### "gh: To use GitHub CLI in a GitHub Actions workflow, set the GH_TOKEN environment variable"
-
-**Cause:** Missing or insufficient token permissions
-
-**Solutions:**
-
-1. Verify PAT includes all required scopes: `repo`, `read:org`, `write:org`, `project`
-2. Test token manually: `gh project field-list PROJECT_NUMBER --owner YOUR_ORG --format json`
-3. Ensure token has access to the specific project
-
 ### General Debugging Tips
 
 - **Test project access:** Use GitHub CLI commands locally with your PAT to verify access

.github/actions/set-date-closed-field-v1/action.yml

@@ -1,5 +1,5 @@
-name: 'Set DateClosed Field on Issue Close'
-description: 'Update the DateClosed project field when an issue is closed as completed'
+name: 'Set Closed Date Field on Issue Action'
+description: 'Update a date project field (default: DateClosed) when an issue is closed as completed'
 inputs:
   token:
     description: 'Token used for the GH CLI to close and move issue(s) to the correct column. See README for required permissions'
@@ -16,7 +16,11 @@ inputs:
   project-number:
     description: 'The project number where the issue is located (should be hardcoded in workflow)'
     required: true
+  date-field-name:
+    description: 'The name of the date field to update the issue close date'
+    required: false
+    default: 'DateClosed'
 
 runs:
   using: 'node24'
-  main: 'dist/index.js' 
+  main: 'dist/index.js'