cis-oss/notify
2
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects 1 Releases 1 Wiki Activity

Feature/release prep #3

Merged
B00tLoad merged 4 commits from feature/release-prep into develop 2025-08-31 15:50:22 +02:00
Conversation 3 Commits 4 Files Changed 2 +168 -3
B00tLoad commented 2025-08-31 15:07:57 +02:00 (Migrated from github.com)
Copy Link

This pull request updates the project’s build and publish configuration, improves script reliability, and adds the maintainers. It also introduces the shx package and updates the lockfile to reflect new dependencies required for cleaning and publishing workflows.

Build/Publish Configuration Improvements:

  • Changed the main entry in package.json from dist/index.js to src/index.ts for local development, and added a publishConfig section to specify publishing from the built dist files. [1] [2]
  • Added a prepublishOnly script to clean and rebuild the project before publishing, and introduced a clean script using shx for cross-platform file removal.

Dependency and Script Updates:

Project Metadata:

  • Added a maintainers section to package.json.

Script Reliability:

  • Fixed the check script to use explicit pnpm run commands for linting and type checking, improving reliability.
This pull request updates the project’s build and publish configuration, improves script reliability, and adds the maintainers. It also introduces the `shx` package and updates the lockfile to reflect new dependencies required for cleaning and publishing workflows. **Build/Publish Configuration Improvements:** * Changed the `main` entry in `package.json` from `dist/index.js` to `src/index.ts` for local development, and added a `publishConfig` section to specify publishing from the built `dist` files. [[1]](diffhunk://#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519L6-R6) [[2]](diffhunk://#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519R83-R99) * Added a `prepublishOnly` script to clean and rebuild the project before publishing, and introduced a `clean` script using `shx` for cross-platform file removal. **Dependency and Script Updates:** * Added `shx` to `devDependencies` and updated `pnpm-lock.yaml` to include all related dependencies (`shx`, `shelljs`, etc.). [[1]](diffhunk://#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519R43) [[2]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR54-R56) [[3]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR2076-R2101) [[4]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR4846-R4847) * Updated lockfile with new packages required by `shx` and its ecosystem (e.g., `shelljs`, `execa`, `pump`, etc.). [[1]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR966-R969) [[2]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR1036-R1038) [[3]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR1131-R1134) [[4]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR1251-R1254) [[5]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR1363-R1366) [[6]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR1410-R1413) [[7]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR1798-R1800) [[8]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR1822-R1825) [[9]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR1857-R1860) [[10]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR1909-R1912) [[11]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR1981-R1983) [[12]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR2009-R2012) [[13]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR2202-R2205) [[14]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR2414-R2417) [[15]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR3458-R3465) [[16]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR3507-R3510) [[17]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR3632-R3641) [[18]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR3784-R3787) [[19]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR3874-R3875) [[20]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR3904-R3905) [[21]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR4486-R4487) [[22]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR4512-R4515) [[23]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR4551-R4552) [[24]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR4596-R4597) [[25]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR4649-R4653) [[26]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR4675-R4678) [[27]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR4727-R4750) [[28]](diffhunk://#diff-32824c984905bb02bc7ffcef96a77addd1f1602cff71a11fbbfdd7f53ee026bbR4846-R4847) **Project Metadata:** * Added a `maintainers` section to `package.json`. **Script Reliability:** * Fixed the `check` script to use explicit `pnpm run` commands for linting and type checking, improving reliability.
copilot-pull-request-reviewer[bot] (Migrated from github.com) reviewed 2025-08-31 15:08:16 +02:00
copilot-pull-request-reviewer[bot] (Migrated from github.com) left a comment
Copy Link

Pull Request Overview

This PR prepares the project for release by configuring build and publish workflows, adding maintainers, and improving script reliability. The changes enable proper development vs. published package configuration while ensuring cross-platform compatibility for build scripts.

  • Updated package.json to use TypeScript source for local development and built JavaScript for publishing
  • Added cross-platform clean script using shx and automated pre-publish workflow
  • Added maintainers section and improved script reliability with explicit pnpm run commands
Files not reviewed (1)
  • pnpm-lock.yaml: Language not supported

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

## Pull Request Overview This PR prepares the project for release by configuring build and publish workflows, adding maintainers, and improving script reliability. The changes enable proper development vs. published package configuration while ensuring cross-platform compatibility for build scripts. - Updated package.json to use TypeScript source for local development and built JavaScript for publishing - Added cross-platform clean script using `shx` and automated pre-publish workflow - Added maintainers section and improved script reliability with explicit `pnpm run` commands <details> <summary>Files not reviewed (1)</summary> * **pnpm-lock.yaml**: Language not supported </details> --- <sub>**Tip:** Customize your code reviews with copilot-instructions.md. <a href="/cis-oss/pushover/new/main/.github?filename=copilot-instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Create the file</a> or <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">learn how to get started</a>.</sub>
package.json
@@ -7,3 +6,3 @@
"main": "dist/index.js",
"main": "src/index.ts",
"author": {
"email": "hi@b00tload.space",
copilot-pull-request-reviewer[bot] (Migrated from github.com) commented 2025-08-31 15:08:16 +02:00
Copy Link

Setting main to a TypeScript file may cause issues for consumers who don't have TypeScript configured. Consider keeping main pointing to the compiled JavaScript and using a separate field like 'source' for the TypeScript entry point during development.

  "main": "dist/index.js",
  "source": "src/index.ts",
Setting main to a TypeScript file may cause issues for consumers who don't have TypeScript configured. Consider keeping main pointing to the compiled JavaScript and using a separate field like 'source' for the TypeScript entry point during development. ```suggestion "main": "dist/index.js", "source": "src/index.ts", ```
B00tLoad (Migrated from github.com) reviewed 2025-08-31 15:15:50 +02:00
package.json
@@ -7,3 +6,3 @@
"main": "dist/index.js",
"main": "src/index.ts",
"author": {
"email": "hi@b00tload.space",
B00tLoad (Migrated from github.com) commented 2025-08-31 15:15:50 +02:00
Copy Link

Not applicable, as this is solved later in the file, in the publish config.

Not applicable, as this is solved later in the file, in the publish config.
jateute (Migrated from github.com) approved these changes 2025-08-31 15:45:18 +02:00
jateute (Migrated from github.com) left a comment
Copy Link

lgtm

lgtm
Sign in to join this conversation.
Reviewers
No Reviewers
copilot-pull-request-reviewer[bot]
B00tLoad
jateute
Labels
Clear labels
bug
Something isn't working
 documentation
Improvements or additions to documentation
 duplicate
This issue or pull request already exists
 enhancement
New feature or request
 good first issue
Good for newcomers
 help wanted
Extra attention is needed
 invalid
This doesn't seem right
 question
Further information is requested
 wontfix
This will not be worked on
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
B00tLoad jateute
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: cis-oss/notify#3
Delete Branch "feature/release-prep"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?