Merge pull request #153 from issue-ops/ncalteen/formatting

Formatting and Typing Cleanup
issue-ops · Nov 1, 2024 · 044382c · 044382c
2 parents 17a5066 + b442e3a
commit 044382c
Show file tree

Hide file tree

Showing 10 changed files with 83 additions and 55 deletions.
diff --git a/.mega-linter.yml b/.mega-linter.yml
@@ -20,6 +20,8 @@ DISABLE:
 # https://megalinter.io/latest/config-activation/
 DISABLE_LINTERS:
   - MARKDOWN_MARKDOWN_TABLE_FORMATTER
+  - REPOSITORY_KICS
+  - REPOSITORY_TRIVY
   - TYPESCRIPT_STANDARD
 
 # List of enabled but not blocking linters keys
@@ -135,7 +137,7 @@ VALIDATE_ALL_CODEBASE: true
 JAVASCRIPT_ES_CONFIG_FILE: .eslintrc.yml
 JAVASCRIPT_PRETTIER_CONFIG_FILE: prettierrc.yml
 JSON_PRETTIER_CONFIG_FILE: prettierrc.yml
-MARKDOWN_MARKDOWNLINT_CONFIG_FILE: .markdownlint.yml
+MARKDOWN_MARKDOWNLINT_CONFIG_FILE: .markdown-lint.yml
 TYPESCRIPT_ES_CONFIG_FILE: .eslintrc.yml
 TYPESCRIPT_PRETTIER_CONFIG_FILE: .prettierrc.yml
 YAML_PRETTIER_CONFIG_FILE: .prettierrc.yml

diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 # IssueOps Releaser
 
-[![Check dist/](https://github.com/issue-ops/releaser/actions/workflows/check-dist.yml/badge.svg)](https://github.com/issue-ops/releaser/actions/workflows/check-dist.yml)
-[![CodeQL](https://github.com/issue-ops/releaser/actions/workflows/codeql.yml/badge.svg)](https://github.com/issue-ops/releaser/actions/workflows/codeql.yml)
-[![Continuous Integration](https://github.com/issue-ops/releaser/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/issue-ops/releaser/actions/workflows/continuous-integration.yml)
-[![Continuous Delivery](https://github.com/issue-ops/releaser/actions/workflows/continuous-delivery.yml/badge.svg)](https://github.com/issue-ops/releaser/actions/workflows/continuous-delivery.yml)
-[![Linter](https://github.com/issue-ops/releaser/actions/workflows/linter.yml/badge.svg)](https://github.com/issue-ops/releaser/actions/workflows/linter.yml)
-[![Code Coverage](./badges/coverage.svg)](./badges/coverage.svg)
+![Check dist/](https://github.com/issue-ops/releaser/actions/workflows/check-dist.yml/badge.svg)
+![CodeQL](https://github.com/issue-ops/releaser/actions/workflows/codeql.yml/badge.svg)
+![Continuous Integration](https://github.com/issue-ops/releaser/actions/workflows/continuous-integration.yml/badge.svg)
+![Continuous Delivery](https://github.com/issue-ops/releaser/actions/workflows/continuous-delivery.yml/badge.svg)
+![Linter](https://github.com/issue-ops/releaser/actions/workflows/linter.yml/badge.svg)
+![Code Coverage](./badges/coverage.svg)
 
 Handle releases for GitHub repositories
 
@@ -78,7 +78,7 @@ jobs:
           ref: main
 
       # Use the version output from the previous step for the release
-      # Prepend a 'v' to the beginning (e.g. 'v1.2.3')
+      # Prepends a 'v' to the beginning (e.g. 'v1.2.3')
       - name: Create Release
         id: create-release
         uses: issue-ops/[email protected]
@@ -95,20 +95,17 @@ Actions variable.
 name: Continuous Delivery
 
 on:
-  pull_request:
-    types:
-      - closed
-    branches:
-      - main
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'The version to release'
+        required: true
+        default: 'v0.0.0'
 
 # This is required to be able to update tags and create releases
 permissions:
   contents: write
 
-# This could also be a GitHub Actions variable
-env:
-  RELEASE_VERSION: v1.2.3
-
 jobs:
   release:
     name: Release Version
@@ -118,44 +115,44 @@ jobs:
     if: ${{ github.event.pull_request.merged == true }}
 
     steps:
-      # Checkout the repository with fetch-tags set to true
+      # Checkout the repository, making sure to set fetch-depth to 0 and
+      # fetch-tags set to true
       - name: Checkout
         id: checkout
         uses: actions/checkout@v4
         with:
+          fetch-depth: 0
           fetch-tags: true
 
-      # Use the version from the environment variable for the release
+      # Use the version from the input variable
       - name: Create Release
         id: create-release
         uses: issue-ops/[email protected]
         with:
-          tag: ${{ env.RELEASE_VERSION }}
+          tag: ${{ inputs.version }}
 ```
 
 ## Inputs
 
-| Input                    | Description                                       |
-| ------------------------ | ------------------------------------------------- |
-| `draft`                  | Whether or not the release should be a draft      |
-|                          | Default: `false`                                  |
-| `generate_release_notes` | Whether or not to generate release notes          |
-|                          | Default: `true`                                   |
-| `github_token`           | The token to use for authentication               |
-|                          | Default: `${{ github.token }}`                    |
-| `name`                   | The name of the release                           |
-|                          | Default: The `tag` value                          |
-| `notes`                  | The release notes, prepended to the generated     |
-|                          | notes if `generate_release_notes` is `true`       |
-| `owner`                  | The owner of the repository                       |
-|                          | Default: The owner of the workflow repository     |
-| `prerelease`             | Whether or not the release should be a prerelease |
-|                          | Default: `false`                                  |
-| `repo`                   | The repository to create the release in           |
-|                          | Default: The workflow repository                  |
-| `tag`                    | The tag to create or reference for the release    |
-| `target_commitish`       | The branch or commit SHA to tag for the release   |
-|                          | Not required if the tag already exists            |
+| Input                    | Description                                                                               |
+| ------------------------ | ----------------------------------------------------------------------------------------- |
+| `draft`                  | Whether or not the release should be a draft                                              |
+|                          | Default: `false`                                                                          |
+| `generate_release_notes` | Whether or not to generate release notes                                                  |
+|                          | Default: `true`                                                                           |
+| `github_token`           | The token to use for authentication                                                       |
+|                          | Default: `${{ github.token }}`                                                            |
+| `name`                   | The name of the release                                                                   |
+|                          | Default: The `tag` value                                                                  |
+| `notes`                  | The release notes, prepended to the generated notes if `generate_release_notes` is `true` |
+| `owner`                  | The owner of the repository                                                               |
+|                          | Default: The owner of the workflow repository                                             |
+| `prerelease`             | Whether or not the release should be a prerelease                                         |
+|                          | Default: `false`                                                                          |
+| `repo`                   | The repository to create the release in                                                   |
+|                          | Default: The workflow repository                                                          |
+| `tag`                    | The tag to create or reference for the release                                            |
+| `target_commitish`       | The branch or commit SHA to tag for the release (not required if the tag already exists)  |
 
 ## Outputs
 

diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -113,6 +113,8 @@ describe('main.ts', () => {
       new Error('Error creating release')
     )
 
-    await expect(main.run()).rejects.toThrow('Error creating release')
+    await main.run()
+
+    expect(core.setFailed).toHaveBeenCalledWith('Error creating release')
   })
 })
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/interfaces.d.ts b/dist/interfaces.d.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "releaser",
   "description": "Handle releases for GitHub repositories",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "type": "module",
   "author": "Nick Alteen <[email protected]>",
   "homepage": "https://github.com/issue-ops/releaser#readme",

diff --git a/src/interfaces.ts b/src/interfaces.ts
@@ -1,3 +1,18 @@
+/**
+ * GitHub Release
+ */
+export interface CreateReleaseOptions {
+  owner: string
+  repo: string
+  tag_name: string
+  name: string
+  draft: boolean
+  prerelease: boolean
+  generate_release_notes: boolean
+  target_commitish?: string
+  body?: string
+}
+
 /**
  * GitHub Release
  */

diff --git a/src/main.ts b/src/main.ts
@@ -1,6 +1,6 @@
 import * as core from '@actions/core'
 import { Octokit } from '@octokit/rest'
-import { Release } from './interfaces.js'
+import type { CreateReleaseOptions, Release } from './interfaces.js'
 
 export async function run(): Promise<void> {
   // Get the inputs
@@ -38,8 +38,7 @@ export async function run(): Promise<void> {
 
   try {
     // Create the API options
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const options: any = {
+    const options: CreateReleaseOptions = {
       owner,
       repo,
       tag_name: tag,
@@ -54,7 +53,8 @@ export async function run(): Promise<void> {
     if (notes !== '') options.body = notes
 
     // Create the release
-    const response = await github.rest.repos.createRelease(options)
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const response = await github.rest.repos.createRelease(options as any)
 
     core.debug(`Response: ${JSON.stringify(response, null, 2)}`)
 
@@ -72,7 +72,6 @@ export async function run(): Promise<void> {
     core.setOutput('upload_url', release.upload_url)
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
   } catch (error: any) {
-    core.setFailed(error.message)
-    throw error
+    return core.setFailed(error.message)
   }
 }