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
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ This is the core repository containing reusable packages for building Solana mic

## Packages

* **@solana/ms-tools-ui**: Reusable React components are built with React, Tailwind CSS, and Shadcn, forming the visual building blocks of microsites.
* **@solana/ms-tools-config**: Shared ESLint and Prettier configurations to ensure consistent code style and quality across all projects.
* **@solana/ms-tools-analytics**: ⚠️ [WIP] Logic for integrating Google Analytics into microsites.
* **@solana/ms-tools-integrations**: Handles integrations with third-party services like Sanity CMS, providing a centralized location for managing these connections.
- **@solana/ms-tools-ui**: UI components for microsites.
- **@solana/ms-tools-integrations**: Integration utilities for microsites.
- **@solana/ms-tools-config**: Shared configuration for microsites.

## Usage

Expand Down
30 changes: 19 additions & 11 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,68 +12,76 @@ This document outlines the step-by-step process for releasing new versions of th
## Release Steps

1. **Pre-release Checklist**

- [ ] Ensure all tests pass: `pnpm test`
- [ ] Ensure the build is successful: `pnpm build`
- [ ] Check that all linting passes: `pnpm lint`
- [ ] Review the changes since the last release
- [ ] Update package changelogs in each modified package

2. **Version Bump**

- Determine the type of version bump (major, minor, patch) based on changes
- Run the appropriate command:

```bash
pnpm changeset
```

- Select all updated packages and proceed with:

```bash
pnpm changeset version
```

- This will update changelog and versions
- Run to update lockfile:

```bash
pnpm install
```

3. **Documentation Updates**

- Ensure each package's README.md is up to date
- Update the main README.md if needed
- Check that all documentation reflects the latest changes
- Update any version references in documentation

4. **Merge your changes**
Create a pull request to the main branch and merge it.
This will trigger the release workflow.

Create a pull request to the main branch and merge it.
This will trigger the release workflow.

## Package-specific Considerations

### @solana/ms-tools-ui

- Ensure all component documentation is updated
- Check that the Storybook build is successful
- Verify visual regression tests

### @solana/ms-tools-config
- Document any breaking changes in ESLint or Prettier configs
- Update migration guides if necessary

### @solana/ms-tools-analytics
- Test Google Analytics integration
- Verify event tracking functionality

### @solana/ms-tools-integrations

- Test all third-party integrations
- Verify API compatibility

### @solana/ms-tools-config

- Document any breaking changes in ESLint or Prettier configs
- Update migration guides if necessary

## Emergency Rollback Procedure

If issues are discovered after release:

1. Tag the problematic version as deprecated:

```bash
pnpm deprecate @solana/[package-name]@version "Reason for deprecation" --registry=https://npm.pkg.github.com
```

2. Roll back to the previous version:

```bash
# Revert the version commit
git revert [version-commit-hash]
Expand Down
9 changes: 0 additions & 9 deletions packages/analytics/CHANGELOG.md

This file was deleted.

81 changes: 0 additions & 81 deletions packages/analytics/README.md

This file was deleted.

18 changes: 0 additions & 18 deletions packages/analytics/eslint.config.mjs

This file was deleted.

40 changes: 0 additions & 40 deletions packages/analytics/package.json

This file was deleted.

7 changes: 0 additions & 7 deletions packages/analytics/prettier.config.js

This file was deleted.

Empty file removed packages/analytics/src/index.ts
Empty file.
1 change: 0 additions & 1 deletion packages/analytics/test/setup.ts

This file was deleted.

26 changes: 0 additions & 26 deletions packages/analytics/tsconfig.json

This file was deleted.

19 changes: 0 additions & 19 deletions packages/analytics/vitest.config.js

This file was deleted.

Loading