Merge pull request #4 from 10up/release/1.0.0

Release/1.0.0

Author: iamdharmesh

.github/CODEOWNERS

@@ -0,0 +1,7 @@
+# These owners will be the default owners for everything in the repo. Unless a later match takes precedence, @iamdharmesh, as primary maintainer will be requested for review when someone opens a Pull Request.
+*                   @iamdharmesh
+
+# GitHub and WordPress.org specifics
+/.github/           @jeffpaul
+CODE_OF_CONDUCT.md  @jeffpaul
+LICENSE.md          @jeffpaul

.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: Publish the NPM package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    name: Publish
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        with:
+          node-version-file: .nvmrc
+          always-auth: true
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Publish
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

@@ -4,4 +4,9 @@ All notable changes to this project will be documented in this file, per [the Ke
 
 ## [Unreleased] - TBD
 
-[Unreleased]: https://github.com/10up/wp-hooks-documentor/compare/trunk...develop
+## [1.0.0] - 2025-08-21
+
+- Initial Release 🎉
+
+[Unreleased]: https://github.com/10up/wp-hooks-documentor/compare/trunk...develop
+[1.0.0]: https://github.com/10up/wp-hooks-documentor/tree/1.0.0

CONTRIBUTING.md

@@ -29,7 +29,7 @@ The `develop` branch is the development branch which means it contains the next
 ## Release instructions
 
 1. Branch: Starting from `develop`, cut a release branch named `release/X.Y.Z` for your changes.
-2. Version bump: Bump the version number in `package.json`, `package-lock.json` and any other relevant files if it does not already reflect the version being released.
+2. Version bump: Bump the version number in `package.json`, `package-lock.json`, `src/cli.ts` and any other relevant files if it does not already reflect the version being released.
 3. Changelog: Add/update the changelog in `CHANGELOG.md`.
 4. Props: update `CREDITS.md` file with any new contributors, confirm maintainers are accurate.
 5. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.gitattributes`.

README.md

@@ -2,10 +2,8 @@
 
 > A powerful tool to generate beautiful documentation for WordPress plugin hooks.
 
-
 [![Support Level](https://img.shields.io/badge/support-beta-blueviolet.svg)](#support-level) [![Release Version](https://img.shields.io/github/release/10up/wp-hooks-documentor.svg)](https://github.com/10up/wp-hooks-documentor/releases/latest) [![MIT License](https://img.shields.io/github/license/10up/wp-hooks-documentor.svg)](https://github.com/10up/wp-hooks-documentor/blob/develop/LICENSE.md) [![CodeQL](https://github.com/10up/wp-hooks-documentor/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/10up/wp-hooks-documentor/actions/workflows/codeql-analysis.yml)
 
-
 ## Features
 
 - 📦 Automatically collects action and filter hooks from your WordPress plugin
@@ -22,19 +20,21 @@
 ## Installation
 
 ```bash
-npm install -g wp-hooks-documentor
+npm install -g @10up/wp-hooks-documentor
 ```
 
 ## Quick Start
 
 1. Initialize a new configuration file:
+
 ```bash
 wp-hooks-documentor init
 ```
 
 2. Edit the generated `wp-hooks-doc.json` file to match your project settings.
 
 3. Generate documentation:
+
 ```bash
 wp-hooks-documentor generate
 ```

package-lock.json

@@ -1,10 +1,10 @@
 {
-  "name": "wp-hooks-documentor",
-  "version": "0.1.0",
+  "name": "@10up/wp-hooks-documentor",
+  "version": "1.0.0",
   "description": "WordPress Plugin Hook Documentation Generator",
   "main": "dist/cli.js",
   "bin": {
-    "wp-hooks-documentor": "./dist/cli.js"
+    "wp-hooks-documentor": "dist/cli.js"
   },
   "files": [
     "dist/**/*",
@@ -14,6 +14,7 @@
     "build": "tsc",
     "start": "node dist/cli.js",
     "dev": "tsc -w",
+    "prepublishOnly": "npm run build",
     "lint": "eslint ./src --ext .ts",
     "lint:fix": "eslint ./src --ext .ts --fix",
     "format": "prettier --write \"src/**/*.ts\"",
@@ -25,7 +26,15 @@
     "documentation",
     "generator"
   ],
-  "author": "10up",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/10up/wp-hooks-documentor.git"
+  },
+  "bugs": {
+    "url": "https://github.com/10up/wp-hooks-documentor/issues"
+  },
+  "homepage": "https://github.com/10up/wp-hooks-documentor#readme",
+  "author": "10up <[email protected]> (https://github.com/10up)",
   "license": "MIT",
   "dependencies": {
     "commander": "^14.0.0",

package.json

@@ -27,7 +27,7 @@ const defaultConfig: WPHooksDocConfig = {
 program
   .name('wp-hooks-documentor')
   .description('Generate documentation for Plugin hooks')
-  .version('0.1.0');
+  .version('1.0.0');
 
 program
   .command('generate')

src/cli.ts

@@ -60,7 +60,7 @@ export class Orchestrator {
           tagline: this.config.tagline || 'Hooks Documentation for Plugin',
           url: this.config.url || 'https://example.com',
           baseUrl: this.config.baseUrl || '/',
-          repoUrl: this.config.repoUrl || 'https://github.com/iamdharmesh/wp-hooks-documentor',
+          repoUrl: this.config.repoUrl || 'https://github.com/10up/wp-hooks-documentor',
           organizationName: this.config.organizationName,
           projectName: this.config.projectName,
           templatesDir: this.config.templatesDir,