Skip to content
Draft
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
8 changes: 8 additions & 0 deletions .changeset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changesets

Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)

We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
11 changes: 11 additions & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": true,
"fixed": [],
"linked": [],
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}
5 changes: 5 additions & 0 deletions .changeset/violet-doodles-film.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@aptos-labs/script-composer-sdk": patch
---

Upgrade dependencies to latest to support Aptos SDK v4 and v5
5 changes: 0 additions & 5 deletions CHANGELOG.md

This file was deleted.

76 changes: 76 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Release Guide

This project uses [Changesets](https://github.com/changesets/changesets) to manage versioning and generate changelogs.

## Important Note

**You only need to use changesets commands from the root directory** - no need to operate in sub-packages.

## Release Process

### 1. Add Change Records

When you're ready to release a new version, first add change records:

```bash
pnpm changeset
```

This command will:
- Let you select which package to release (in this project: `@aptos-labs/script-composer-sdk`)
- Let you choose the version type (patch/minor/major)
- Let you input a change description

### 2. Preview Version Changes

Before officially releasing, you can preview version changes:

```bash
pnpm version-packages
```

This will:
- Update the version number in `packages/sdk/package.json`
- Automatically generate `packages/sdk/CHANGELOG.md` (package version history)
- But will NOT actually publish to npm

### 3. Publish to npm

After confirming the version changes are correct, execute the release:

```bash
pnpm release
```

This will:
- Build all packages
- Publish to npm registry
- Create git tags

### 4. Dry Run (Testing)

If you want to test the release process without actually publishing:

```bash
pnpm release:dry-run
```

## Common Commands

- `pnpm changeset` - Add new change records
- `pnpm version-packages` - Update version numbers and changelogs
- `pnpm release` - Build and publish to npm
- `pnpm release:dry-run` - Test release process

## Important Notes

1. Make sure to run `pnpm build` and `pnpm test` before releasing to ensure code quality
2. Change records should clearly describe user-visible changes
3. Version numbers follow [Semantic Versioning](https://semver.org/) specification
4. Ensure all changes are committed to git before releasing

## Version Type Explanation

- **patch** (0.0.X): Bug fixes, backward compatible
- **minor** (0.X.0): New features, backward compatible
- **major** (X.0.0): Breaking changes, not backward compatible
11 changes: 9 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,17 @@
"description": "Script Composer SDK and Examples",
"scripts": {
"build": "pnpm -r build",
"test": "pnpm -r test"
"test": "pnpm -r test",
"changeset": "changeset",
"version-packages": "changeset version",
"release": "pnpm build && changeset publish",
"release:dry-run": "changeset publish --dry-run"
},
"keywords": [],
"author": "",
"license": "ISC",
"packageManager": "[email protected]"
"packageManager": "[email protected]",
"devDependencies": {
"@changesets/cli": "^2.29.7"
}
}
Loading