Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [],
"linked": [],
"linked": [["@openai/agents-*"]],
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should properly link the versions now

"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
Expand Down
7 changes: 7 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,13 @@ const sidebar = [
ja: 'トラブルシューティング',
},
},
{
label: 'Release process',
link: '/guides/release',
translations: {
ja: 'リリースプロセス',
},
},
],
},
{
Expand Down
39 changes: 39 additions & 0 deletions docs/src/content/docs/guides/release.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Release process
description: Learn how we version and release the SDK and recent changes.
---

import { Content as AgentsSdkChangelog } from '../../../../../packages/agents/CHANGELOG.md';

## Versioning

The project follows a slightly modified version of semantic versioning using the form `0.Y.Z`. The leading `0` indicates the SDK is still evolving rapidly. Increment the components as follows:

## Minor (`Y`) versions

We will increase minor versions `Y` for **breaking changes** to any public interfaces that are not marked as beta. For example, going from `0.0.x` to `0.1.x` might include breaking changes.

If you don't want breaking changes, we recommend pinning to `0.0.x` versions in your project.

## Patch (`Z`) versions

We will increment `Z` for non-breaking changes:

- Bug fixes
- New features
- Changes to private interfaces
- Updates to beta features

## Versioning sub-packages

The main `@openai/agents` package is comprised of multiple sub-packages that can be used independently. At the moment the versions of the packages are linked, meaning if one package receives a version increase, so do the others. We might change this strategy as we move to `1.0.0`.

## Changelogs

We generate changelogs for each of the sub-packages to help understand what has changed. As the changes might have happened in a sub-package, you might have to look in that respective changelog for details on the change.

- [`@openai/agents`](https://github.com/openai/openai-agents-js/blob/main/packages/agents/CHANGELOG.md)
- [`@openai/agents-core`](https://github.com/openai/openai-agents-js/blob/main/packages/agents-core/CHANGELOG.md)
- [`@openai/agents-extensions`](https://github.com/openai/openai-agents-js/blob/main/packages/agents-extensions/CHANGELOG.md)
- [`@openai/agents-openai`](https://github.com/openai/openai-agents-js/blob/main/packages/agents-openai/CHANGELOG.md)
- [`@openai/agents-realtime`](https://github.com/openai/openai-agents-js/blob/main/packages/agents-realtime/CHANGELOG.md)
39 changes: 39 additions & 0 deletions docs/src/content/docs/ja/guides/release.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: リリースプロセス
description: Learn how we version and release the SDK and recent changes.
---

import { Content as AgentsSdkChangelog } from '../../../../../../packages/agents/CHANGELOG.md';

## バージョニング

このプロジェクトでは、`0.Y.Z` 形式を用いたわずかに変更されたセマンティック バージョニングを採用しています。先頭の `0` は、SDK がまだ急速に進化していることを示します。各コンポーネントの増分ルールは次のとおりです:

## マイナー (`Y`) バージョン

ベータでない公開インターフェースに **breaking changes** がある場合、マイナー バージョン `Y` を上げます。たとえば、`0.0.x` から `0.1.x` への更新には breaking changes が含まれる可能性があります。

破壊的変更を避けたい場合は、プロジェクトで `0.0.x` バージョンに固定することを推奨します。

## パッチ (`Z`) バージョン

`Z` は非破壊的変更の場合に増分します:

- バグ修正
- 新機能
- プライベート インターフェースの変更
- ベータ機能の更新

## サブパッケージのバージョニング

メインの `@openai/agents` パッケージは、単体でも利用可能な複数のサブパッケージで構成されています。現在は各パッケージのバージョンが連動しており、いずれかのパッケージでバージョンが上がると他も同時に上がります。`1.0.0` に移行する段階で、この戦略を変更する可能性があります。

## 変更履歴

各サブパッケージごとに変更履歴を生成しているため、何が変更されたかを確認できます。変更はサブパッケージ内で発生している場合があるため、詳細は該当する変更履歴をご確認ください。

- [`@openai/agents` の変更履歴](https://github.com/openai/openai-agents-js/blob/main/packages/agents/CHANGELOG.md)
- [`@openai/agents-core` の変更履歴](https://github.com/openai/openai-agents-js/blob/main/packages/agents-core/CHANGELOG.md)
- [`@openai/agents-extensions` の変更履歴](https://github.com/openai/openai-agents-js/blob/main/packages/agents-extensions/CHANGELOG.md)
- [`@openai/agents-openai` の変更履歴](https://github.com/openai/openai-agents-js/blob/main/packages/agents-openai/CHANGELOG.md)
- [`@openai/agents-realtime` の変更履歴](https://github.com/openai/openai-agents-js/blob/main/packages/agents-realtime/CHANGELOG.md)