Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(deps): update dependency openai to v4.76.0 #220

Merged
merged 1 commit into from
Dec 14, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 11, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
openai 4.73.1 -> 4.76.0 age adoption passing confidence

Release Notes

openai/openai-node (openai)

v4.76.0

Compare Source

Full Changelog: v4.75.0...v4.76.0

Features
Chores

v4.75.0

Compare Source

Full Changelog: v4.74.0...v4.75.0

Features

v4.74.0

Compare Source

Full Changelog: v4.73.1...v4.74.0

Features

Configuration

📅 Schedule: Branch creation - "* 0-4 * * 3" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Copy link

bedrock debug - [puLL-Merge] - openai/[email protected]

Description

This PR updates the OpenAI Node.js library from version 4.73.1 to 4.76.0. It includes several new features, improvements to documentation, and changes to the build process for better compatibility with different installation methods.

Changes

Changes

  1. Version Updates:

    • Updated version numbers in .release-please-manifest.json, jsr.json, package.json, and src/version.ts from 4.73.1 to 4.76.0.
  2. OpenAPI Specification:

    • Updated the OpenAPI spec URL in .stats.yml.
  3. Changelog (CHANGELOG.md):

    • Added entries for versions 4.76.0, 4.75.0, and 4.74.0, detailing new features and chores.
  4. Build Process:

    • Modified scripts/build-deno to include a new step for converting the README for JSR (JavaScript Runtime) compatibility.
    • Added a new script scripts/utils/convert-jsr-readme.cjs to transform the README for JSR compatibility.
    • Added a new script scripts/utils/git-swap.sh to restructure the package for git installs.
    • Updated package.json to use the new git-swap.sh script in the prepare command.
  5. Documentation:

    • Improvements to the JSR README (mentioned in the changelog but not visible in the diff).
  6. Installation Process:

    • Changes to handle git installs differently, making the structure match npm installs.

This sequence diagram illustrates the flow of the updated build and publish process, including the new steps for JSR compatibility and git install restructuring.```mermaid
sequenceDiagram
participant Dev as Developer
participant Git as Git Repository
participant NPM as NPM Registry
participant Build as Build Process
participant JSR as JSR Compatibility

Dev->>Git: Push changes
Git->>Build: Trigger build process
Build->>Build: Update version numbers
Build->>Build: Generate changelog
Build->>JSR: Convert README for JSR
Build->>Build: Restructure for git installs
Build->>NPM: Prepare for npm publish
Build->>JSR: Prepare for JSR publish
NPM-->>Dev: Publish to npm
JSR-->>Dev: Publish to JSR
</details>

<!-- Generated by anthropic.claude-3-5-sonnet-20240620-v1:0 -->

Copy link

openai debug - [puLL-Merge] - openai/[email protected]

Description

This pull request updates several configuration and versioning files in preparation for the release of version 4.76.0 of the OpenAI Node.js library. The main changes also include a new script for converting JSR-specific README files, and a shell script to adjust the file structure during Git installations.

Possible Issues

  1. Backward Compatibility: Changes in scripts, especially in git-swap.sh and convert-jsr-readme.cjs, may cause unexpected behavior in some environments. Make sure these have been tested thoroughly.
  2. Documentation: The changelog entries are useful, but there seems to be no documentation update related to the changes in the new scripts and the updated OpenAPI spec. It may help provide additional clarity to developers.

Security Hotspots

  1. Path Manipulation in Scripts: The usage of find and mv commands in git-swap.sh performs operations on the file system that may be risky if not handled correctly, especially regarding directory traversal and cleanup. Ensure these operations do not inadvertently remove important files.
Changes

Changes

.release-please-manifest.json

2c2
-  ".": "4.73.1"
+  ".": "4.76.0"

.stats.yml

2c2
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-aa9b01fc0c17eb0cbc200533fc20d6a49c5e764ceaf8049e08b294532be6e9ff.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-2e0e0678be19d1118fd796af291822075e40538dba326611e177e9f3dc245a53.yml

CHANGELOG.md

+## 4.76.0 (2024-12-05)
+
+Full Changelog: [v4.75.0...v4.76.0](https://github.com/openai/openai-node/compare/v4.75.0...v4.76.0)
+
+### Features
+* **api:** updates ([#1212](https://github.com/openai/openai-node/issues/1212)) ([e0fedf2](https://github.com/openai/openai-node/commit/e0fedf2c5a91d0c03d8dad6854b366f77eab4923))
+
+### Chores
+* bump openapi url ([#1210](https://github.com/openai/openai-node/issues/1210)) ([3fa95a4](https://github.com/openai/openai-node/commit/3fa95a429d4b2adecce35a7b96b73f6d5e88eeeb))

jsr.json

-  "version": "4.73.1",
+  "version": "4.76.0",

package.json

-  "version": "4.73.1",
+  "version": "4.76.0",
3a4
+    "git-swap": "./scripts/utils/git-swap.sh",

scripts/build-deno

+node scripts/utils/convert-jsr-readme.cjs ./dist-deno/README.md

scripts/utils/check-is-in-git-install.sh

-#!/bin/bash
+#!/usr/bin/env bash

scripts/utils/convert-jsr-readme.cjs

New file added to handle the conversion of README files for JSR specifications. This includes AST traversal and text replacements.

scripts/utils/git-swap.sh

New file added to adjust the structure of the package during Git installations to match that of npm installations.

src/version.ts

-export const VERSION = '4.73.1'; // x-release-please-version
+export const VERSION = '4.76.0'; // x-release-please-version

This sequence diagram outlines the workflow impacted by this pull request, from the PR submission to the final package publication. The new scripts added within this PR (convert-jsr-readme.cjs and git-swap.sh) would be utilized in the CI phase to ensure proper setup and structure of the package before it's published.```mermaid
sequenceDiagram
participant Dev as Developer
participant Repo as Repository
participant CI as Continuous Integration
participant NPM as NPM Registry

Dev->>Repo: Submits PR
Repo->>Dev: PR Review
Repo->>CI: Merge PR
CI->>Repo: Run Tests & Build
CI->>NPM: Publish Package
</details>

<!-- Generated by gpt-4o-2024-05-13 -->

Copy link

anthropic debug - [puLL-Merge] - openai/[email protected]

Description

This PR updates the OpenAI Node.js library from version 4.73.1 to 4.76.0. It includes several feature updates, changes to the build process, and improvements to documentation, particularly for JSR (JavaScript Registry) compatibility.

Changes

Changes

  1. Version Updates:

    • Updated version from 4.73.1 to 4.76.0 in multiple files:
      • .release-please-manifest.json
      • jsr.json
      • package.json
      • src/version.ts
  2. CHANGELOG.md:

    • Added entries for versions 4.76.0, 4.75.0, and 4.74.0
    • New features and chores are documented for each version
  3. Build Process:

    • Modified scripts/build-deno to include a new step for converting JSR README
    • Added new script scripts/utils/convert-jsr-readme.cjs for JSR README conversion
    • Added new script scripts/utils/git-swap.sh for reorganizing files in git installs
  4. Package Configuration:

    • Updated package.json to use the new git-swap script in the prepare step
  5. Documentation:

    • Improved docs for JSR README.md (mentioned in changelog)
  6. OpenAPI Specification:

    • Updated OpenAPI spec URL in .stats.yml
sequenceDream
    participant Developer
    participant BuildScript
    participant GitInstall
    participant NPMInstall

    Developer->>BuildScript: Run build process
    BuildScript->>BuildScript: Execute build-deno script
    BuildScript->>BuildScript: Convert JSR README
    
    alt Git Install
        GitInstall->>GitInstall: Run prepare script
        GitInstall->>GitInstall: Execute git-swap.sh
        GitInstall->>GitInstall: Reorganize file structure
    else NPM Install
        NPMInstall->>NPMInstall: Standard npm installation
    end

    Developer->>Developer: Use updated OpenAI library (v4.76.0)
Loading

Possible Issues

  • The new git-swap script dramatically changes the file structure for git installs. This could potentially cause issues for users who have custom build or development processes that depend on the previous file structure.

Security Hotspots

No significant security issues are apparent in this change.

This diagram illustrates the new build and installation process, highlighting the differences between git and npm installations due to the new git-swap script.

@thypon thypon merged commit 3fd3724 into main Dec 14, 2024
8 checks passed
@thypon thypon deleted the renovate/openai-4.x-lockfile branch December 14, 2024 07:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant