@silexlabs/my-package

A minimal TypeScript package ready to publish on npm with OIDC authentication.

Features

• TypeScript support with declaration files
• Automated publishing via GitHub Actions
• OIDC authentication (no npm tokens needed)
• Automatic npm tag management (latest/next)
• Provenance attestation enabled

Prerequisites

Before publishing, configure npm Trusted Publisher:

1. Go to npmjs.com and log in
2. Navigate to your package (create it first if needed, or it will be created on first publish)
3. Go to Settings > Publishing access
4. Click "Add provider" under "Trusted Publishers"
5. Fill in:
   • Provider: GitHub Actions
   • Repository: your-username/your-repo
   • Workflow: publish.yml
   • Environment: (leave empty)

Installation

npm install

Build

npm run build

Testing the Publication Workflow

1. Initialize Git Repository

git init
git add .
git commit -m "Initial commit"

2. Create GitHub Repository

Create a new repository on GitHub (must match the one configured in npm Trusted Publisher).

git remote add origin https://github.com/your-username/your-repo.git
git push -u origin main

3. Create and Push a Tag

For a stable release (will be tagged as latest on npm):

git tag v1.0.0
git push origin v1.0.0

For a pre-release (will be tagged as next on npm):

git tag v1.0.0-beta.1
git push origin v1.0.0-beta.1

4. Monitor the Workflow

1. Go to your GitHub repository
2. Click on "Actions" tab
3. Watch the "Publish to npm" workflow run
4. Once completed, check your package on npmjs.com

Version Tag Management

The workflow automatically determines the npm dist-tag:

• latest: For stable versions (e.g., v1.0.0, v2.1.3)
• next: For pre-releases containing: alpha, beta, rc, or next (e.g., v1.0.0-beta.1, v2.0.0-rc.1)

Usage (After Publishing)

import { greet } from '@silexlabs/my-package';

console.log(greet('World')); // "Hello, World!"

Development

1. Make your changes in src/
2. Build: npm run build
3. Test locally
4. Commit and push
5. Create a tag and push to trigger publication

License

MIT