@ezhang6811/npm-publish-test 1.0.0

package/.github/workflows/test-publish.yml

@@ -0,0 +1,22 @@
+name: Test NPM Publish
+on:
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          registry-url: 'https://registry.npmjs.org'
+      
+      - name: Test publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_CONFIG_PROVENANCE: true
+        run: npm publish

package/README.md

@@ -0,0 +1,38 @@
+# npm-publish-test
+test publishing to npm with OIDC auth
+
+## Installation
+
+```bash
+npm install npm-publish-test
+```
+
+## Usage
+
+```javascript
+const { hello, add } = require('npm-publish-test');
+
+// Use the hello function
+console.log(hello()); // Output: Hello, World!
+console.log(hello('Alice')); // Output: Hello, Alice!
+
+// Use the add function
+console.log(add(2, 3)); // Output: 5
+```
+
+## API
+
+### `hello(name)`
+
+Returns a greeting message.
+
+- **name** (string, optional): The name to greet. Defaults to 'World'.
+- **Returns**: (string) A greeting message
+
+### `add(a, b)`
+
+Adds two numbers together.
+
+- **a** (number): The first number to add
+- **b** (number): The second number to add
+- **Returns**: (number) Sum of a and b

package/index.js

@@ -0,0 +1,24 @@
+/**
+ * A simple hello world function
+ * @param {string} name - The name to greet
+ * @returns {string} A greeting message
+ */
+function hello(name = 'World') {
+  return `Hello, ${name}!`;
+}
+
+/**
+ * A simple addition function
+ * @param {number} a - First number
+ * @param {number} b - Second number
+ * @returns {number} Sum of a and b
+ */
+function add(a, b) {
+  return a + b;
+}
+
+// Export the functions
+module.exports = {
+  hello,
+  add
+};

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@ezhang6811/npm-publish-test",
+  "version": "1.0.0",
+  "description": "test publishing to npm with OIDC auth",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ezhang6811/npm-publish-test.git"
+  },
+  "scripts": {
+    "test": "node index.js"
+  },
+  "keywords": [
+    "test",
+    "npm",
+    "publish"
+  ],
+  "author": "ezhang6811",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  }
+}