Deploying JS Modules Using the GitHub Student Plan

# Initialize a new JS module
mkdir my-js-module
cd my-js-module
npm init -y
git init
git remote add origin https://github.com/YOUR_USERNAME/my-js-module.git

{
  "name": "@YOUR_USERNAME/my-js-module",
  "version": "1.0.0",
  "description": "A utility module for string operations",
  "main": "src/index.js",
  "type": "module",
  "exports": {
    ".": "./src/index.js",
    "./utils": "./src/utils.js"
  },
  "scripts": {
    "test": "node --test tests/",
    "lint": "eslint src/",
    "build": "echo 'No build step needed for pure ESM'"
  },
  "files": ["src/"],
  "keywords": ["utility", "string"],
  "license": "MIT"
}

# Create a Personal Access Token with read:packages and write:packages scopes
# Then login
npm login --scope=@YOUR_USERNAME --registry=https://npm.pkg.github.com

npm publish

npm install @YOUR_USERNAME/my-js-module

import { capitalize, slugify } from "@YOUR_USERNAME/my-js-module";

# .github/workflows/ci.yml
name: CI
 
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
 
jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [18, 20, 22]
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node-version }}
      - run: npm ci
      - run: npm test
      - run: npm run lint
 
  publish:
    needs: test
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    permissions:
      packages: write
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
          registry-url: https://npm.pkg.github.com
      - run: npm ci
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

# .github/workflows/deploy-pages.yml
name: Deploy to GitHub Pages
 
on:
  push:
    branches: [main]
 
permissions:
  pages: write
  id-token: write
 
jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
      - run: npm ci
      - run: npm run build
      - uses: actions/upload-pages-artifact@v3
        with:
          path: dist/
      - id: deployment
        uses: actions/deploy-pages@v4

# Install Vercel CLI
npm install -g vercel
 
# Link and deploy
vercel login
vercel

{
  "framework": null,
  "buildCommand": "npm run build",
  "outputDirectory": "dist",
  "rewrites": [
    { "source": "/(.*)", "destination": "/index.html" }
  ]
}

# Install Railway CLI
npm install -g @railway/cli
 
# Login and deploy
railway login
railway init
railway up

# Patch release (bug fix): 1.0.0 -> 1.0.1
npm version patch
 
# Minor release (new feature): 1.0.0 -> 1.1.0
npm version minor
 
# Major release (breaking change): 1.0.0 -> 2.0.0
npm version major

# Publish only on version tags
on:
  push:
    tags:
      - 'v*'
 
jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
          registry-url: https://npm.pkg.github.com
      - run: npm ci
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}