v1.0 release

Author: d-sys-admin

.github/workflows/codeql-analysis.yml

@@ -1,46 +1,48 @@
-# OpenAI Summarize Diff Action
+# openai summarize diff action
+[![node.js ci](https://github.com/captradeoff/openai-summarize-diff-action/actions/workflows/node.js.yml/badge.svg)](https://github.com/captradeoff/openai-summarize-diff-action/actions/workflows/node.js.yml)
+![GitHub License](https://img.shields.io/github/license/captradeoff/openai-summarize-diff-action)
 
-This GitHub Action receives a git diff (e.g., a PR diff) and uses OpenAI to summarize and explain the changes made in that diff in a clear, concise way.
+this github action receives a git diff (e.g., a pr diff) and uses openai to summarize and explain the changes made in that diff in a clear, concise way.
 
-## Features
+## features
 
-- Generates concise explanations of code changes
-- Customizable output length and style
-- Easy to integrate into your CI/CD workflow
-- Now includes comprehensive tests and error handling
+- generates concise explanations of code changes
+- customizable output length and style
+- easy to integrate into your ci/cd workflow
+- now includes comprehensive tests and error handling
 
-## Inputs
+## inputs
 
 ### `diff`
 
-**Required** The diff to be explained.
+**required** the diff to be explained.
 
 ### `apikey`
 
-**Required** Your OpenAI API key. Get one at [OpenAI Platform](https://platform.openai.com/api-keys).
+**required** your openai api key. get one at [openai platform](https://platform.openai.com/api-keys).
 
-### `examplePostSummary`
+### `examplepostsummary`
 
-**Optional** An example summary to guide the model's output style.
-Default: "update the code with new features: parallelisation, caching, and better error handling"
+**optional** an example summary to guide the model's output style.
+default: "update the code with new features: parallelisation, caching, and better error handling"
 
-### `maxTokens`
+### `maxtokens`
 
-**Optional** Maximum number of tokens to generate. Default: `30`
+**optional** maximum number of tokens to generate. default: `30`
 
-### `maxCharacters`
+### `maxcharacters`
 
-**Optional** Maximum characters in the generated explanation. Default: `140`
+**optional** maximum characters in the generated explanation. default: `140`
 
-## Outputs
+## outputs
 
 ### `explanation`
 
-The explanation and summary of the diff generated by OpenAI.
+the explanation and summary of the diff generated by openai.
 
-## Example usage
+## example usage
 
-### To explain the changes made in a PR
+### to explain the changes made in a pr
 
 ```yaml
 name: Explain PR Changes
@@ -78,7 +80,7 @@ jobs:
         run: echo "${{ steps.explain.outputs.explanation }}"
 ```
 
-### To explain the changes and post the result as a comment in the PR
+### to explain the changes and post the result as a comment in the pr
 
 ```yaml
 name: Explain PR Changes and Comment
@@ -130,62 +132,62 @@ jobs:
           EXPLANATION: ${{ steps.explain.outputs.explanation }}
 ```
 
-## Local Development
+## local development
 
-### Setup
+### setup
 
-1. Clone the repository:
+1. clone the repository:
    ```bash
    git clone https://github.com/your-username/openai-summarize-diff-action.git
    cd openai-summarize-diff-action
    ```
 
-2. Install dependencies:
+2. install dependencies:
    ```bash
    npm install
    ```
 
-3. Create a `.env` file with your OpenAI API key:
+3. create a `.env` file with your openai api key:
    ```
    OPENAI_API_KEY=your_api_key_here
    ```
 
-### Testing
+### testing
 
-Run tests:
+run tests:
 ```bash
 npm test
 ```
 
-Run tests with coverage:
+run tests with coverage:
 ```bash
 npm run test:coverage
 ```
 
-Run tests in watch mode (useful during development):
+run tests in watch mode (useful during development):
 ```bash
 npm run test:watch
 ```
 
-### Linting
+### linting
 
-Run linting:
+run linting:
 ```bash
 npm run lint
 ```
 
-### Building
+### building
 
-Build the action:
+build the action:
 ```bash
 npm run build
 ```
 
-This will run linting, tests, and then build the action into the `dist` directory.
+this will run linting, tests, and then build the action into the `dist` directory.
 
-### Manual Testing
+### manual testing
 
-You can test the action locally by creating a test script:
+you can test the action locally by creating a test script:
 
 ```javascript
 // test-local.js
@@ -219,17 +221,17 @@ index 123..456 789
 test();
 ```
 
-Run the test script:
+run the test script:
 ```bash
 node test-local.js
 ```
 
-## Notes
+## notes
 
-- This action uses OpenAI's GPT-4o-mini model by default.
-- Make sure to store your OpenAI API key as a secret in your repository settings.
-- The action will ignore library folders to focus on meaningful code changes.
+- this action uses openai's gpt-4o-mini model by default.
+- make sure to store your openai api key as a secret in your repository settings.
+- the action will ignore library folders to focus on meaningful code changes.
 
-## License
+## license
 
-ISC
+[mit](https://github.com/captradeoff/openai-summarize-diff-action/blob/main/LICENSE)

.github/workflows/licensed.yml

@@ -1,5 +1,5 @@
 name: 'OpenAI Summarize Diff'
-description: 'Uses OpenAI to explain and summarize git diffs in a clear, concise way'
+description: 'Uses OpenAI to explain the changes in the last git diff in a concise manner'
 inputs:
   diff:
     description: 'The Git diff to be explained'
@@ -23,6 +23,6 @@ runs:
   using: 'node20'
   main: 'dist/index.js'
 branding:
-  icon: 'message-square'
-  color: 'green'
+  icon: 'code'
+  color: 'white'