feat: add locale input (#26)

.github/workflows/build-test.yml

@@ -104,5 +104,6 @@ jobs:
  jira_ticket_prefix: "ABC"
  jira_instance_url: "https://example.atlassian.net"
  time_zone_offset: "-4" # Toronto (Canada - Ontario)
+ locale: "fr-FR"
 
 

README.md

@@ -46,24 +46,26 @@ jobs:
  contributor_replace_regex: "-"
  contributor_replace_char: "."
  time_zone_offset: "-4" # Toronto (Canada - Ontario)
+ locale: "fr-FR"
 ```
 
 #### Inputs
 
-| Name | Required | Default | Description |
-| --------------------------- | -------- | ------------------------- | --------------------------------------------------------------------------------------------------------- |
-| `github_token` | yes | | Token to use to authorize label changes. Typically the GITHUB_TOKEN secret |
-| `repo` | no | | Name of the repo (e.g. owner/repo) if not the current one |
-| `tag_regex` | no | ^v[0-9]+\.[0-9]+\.[0-9]+$ | Regex to accommodate varying tag formatting. |
-| `time_zone_offset` | no | 0 | Timezone offset in minutes from UTC. |
-| `contributor_replace_regex` | no | | Regular expression (regex) pattern to identify characters in the `contributor` name that will be replaced |
-| `contributor_replace_char` | no | | The character that will replace specific characters in the `contributor` name |
-| `slack_webhook_urls` | no | | Slack webhook URL to receive release notifications |
-| `jira_ticket_prefix` | no | | Prefix for JIRA ticket references in PR titles (e.g. ABC) |
-| `jira_instance_url` | no | | URL for your JIRA instance to generate JIRA ticket links (e.g. https://your-jira-instance.com) |
-| `sentry_project_name` | no | | ID of the Sentry project for error tracking |
-| `sentry_project_name` | no | | Name of the Sentry project for error tracking |
-| `grafana_dashboard_link` | no | | Link to the Grafana dashboard for monitoring |
+| Name | Required | Default | Description |
+| --------------------------- | -------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| `github_token` | yes | | Token to use to authorize label changes. Typically the GITHUB_TOKEN secret |
+| `repo` | no | | Name of the repo (e.g. owner/repo) if not the current one |
+| `tag_regex` | no | ^v[0-9]+\.[0-9]+\.[0-9]+$ | Regex to accommodate varying tag formatting. |
+| `time_zone_offset` | no | 0 | Timezone offset in minutes from UTC. |
+| `locale` | no | en-US | Preferred locale for date formatting, adhering to the BCP 47 language tag standard (e.g., 'en-US' for American English) |
+| `contributor_replace_regex` | no | | Regular expression (regex) pattern to identify characters in the `contributor` name that will be replaced |
+| `contributor_replace_char` | no | | The character that will replace specific characters in the `contributor` name |
+| `slack_webhook_urls` | no | | Slack webhook URL to receive release notifications |
+| `jira_ticket_prefix` | no | | Prefix for JIRA ticket references in PR titles (e.g. ABC) |
+| `jira_instance_url` | no | | URL for your JIRA instance to generate JIRA ticket links (e.g. https://your-jira-instance.com) |
+| `sentry_project_name` | no | | ID of the Sentry project for error tracking |
+| `sentry_project_name` | no | | Name of the Sentry project for error tracking |
+| `grafana_dashboard_link` | no | | Link to the Grafana dashboard for monitoring |
 
 
 ### Outputs

action.yml

@@ -58,6 +58,11 @@ inputs:
  required: false
  default: '0' # Default is 0, i.e., UTC time
 
+ locale:
+ description: 'Locale for date formatting'
+ required: false
+ default: 'en-US' # Default locale is American English
+
 runs:
  using: node16
  main: dist/index.js

src/__tests__/index.test.ts

@@ -45,6 +45,7 @@ describe('run function', () => {
  contributorReplaceRegex: '-',
  tagRegex: '^v[0-9]+.[0-9]+.[0-9]+$',
  timeZoneOffset: '0',
+ locale: 'fr-FR'
  })
 
  const getOwnerAndRepoMock = jest.spyOn(getOwnerAndRepoModule, 'getOwnerAndRepo')

src/utils/__tests__/__mocks__/testData.ts

@@ -65,4 +65,5 @@ export const MOCK_GET_INPUTS = {
  contributorReplaceRegex: '-',
  tagRegex: '^v[0-9]+.[0-9]+.[0-9]+$',
  timeZoneOffset: '0',
+ locale: 'fr-FR'
 }

src/utils/__tests__/getInputs.test.ts

@@ -28,6 +28,8 @@ describe('getInputs', () => {
  return 'my-tag-regex'
  case 'time_zone_offset':
  return 'GTM-0'
+ case 'locale':
+ return 'locale'
  default:
  return ''
  }
@@ -48,6 +50,7 @@ describe('getInputs', () => {
  contributorReplaceRegex: '-',
  tagRegex: 'my-tag-regex',
  timeZoneOffset: '0',
+ locale: 'locale',
  }
 
  expect(getInputs()).toEqual(expectedInputs)
@@ -106,6 +109,8 @@ describe('getInputs', () => {
  return '^v[0-9]+.[0-9]+.[0-9]+$'
  case 'time_zone_offset':
  return '0'
+ case 'locale':
+ return 'fr-FR'
  default:
  return ''
  }
@@ -127,6 +132,7 @@ describe('getInputs', () => {
  contributorReplaceRegex: '-',
  tagRegex: '^v[0-9]+.[0-9]+.[0-9]+$',
  timeZoneOffset: '0',
+ locale: 'fr-FR',
  }
 
  expect(getInputs()).toEqual(expectedInputs)

src/utils/getCurrentDate.ts

@@ -1,11 +1,11 @@
-export function getCurrentDate(timeZoneOffset: string): string {
+export function getCurrentDate(timeZoneOffset: string, locale: string): string {
  const offset = Number(timeZoneOffset)
 
  const date = new Date()
  const utcDate = date.getTime() + date.getTimezoneOffset() * 60 * 1000
  const targetDate = new Date(utcDate + offset * 60 * 60 * 1000)
 
- return targetDate.toLocaleString('en-US', {
+ return targetDate.toLocaleString(locale, {
  year: 'numeric',
  month: 'long',
  day: 'numeric',

src/utils/getInputs.ts

@@ -32,6 +32,7 @@ export interface GetInputsType {
  contributorReplaceChar: string
  contributorReplaceRegex: string
  timeZoneOffset: string
+ locale: string
 }
 
 /**
@@ -53,6 +54,7 @@ export function getInputs(): GetInputsType {
  const contributorReplaceChar = core.getInput('contributor_replace_char') || ''
  const contributorReplaceRegex = core.getInput('contributor_replace_regex') || ''
  let timeZoneOffset = core.getInput('time_zone_offset') || '0'
+ const locale = core.getInput('locale') || 'en-US'
 
  // Input value checking example for URLs
  if (grafanaDashboardLink && !isValidUrl(grafanaDashboardLink)) {
@@ -121,5 +123,6 @@ export function getInputs(): GetInputsType {
  contributorReplaceChar,
  contributorReplaceRegex,
  timeZoneOffset,
+ locale,
  }
 }

src/utils/handleSlackNotification.ts

@@ -78,7 +78,7 @@ export async function handleSlackNotification({
  )
 
  // Get the current date in the specified time zone
- const currentDate = getCurrentDate(options.timeZoneOffset)
+ const currentDate = getCurrentDate(options.timeZoneOffset, options.locale)
 
  // Generate the Slack message data, which includes information about the repository, the release, the commit of the current tag,
  // the list of pull requests, and the current date