Skip to content

feat!: remove child_process dependency for browser compatibility (#… #982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 19, 2025

Conversation

intcreator
Copy link
Collaborator

…968)

Description

BREAKING CHANGE: Removed the ability to execute system commands using string-based inputs. This eliminates the dependency on child_process, improving browser compatibility. Users relying on this functionality should migrate to executing commands manually within their own implementations.

Related Issue

#967

Motivation and Context

Running node-cron in a browser-based environment.

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • [ X ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • [ X ] My code follows the code style of this project.
  • [ X ] My change requires a change to the documentation.
  • [ X ] I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • [ X ] All new and existing tests passed.
  • [ X ] If my change introduces a breaking change, I have added a ! after the type/scope in the title (see the Conventional Commits standard).

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • If my change introduces a breaking change, I have added a ! after the type/scope in the title (see the Conventional Commits standard).

)

<!--- Provide a general summary of your changes in the Title above
(following the Conventional Commits standard) -->
<!-- More infos: https://www.conventionalcommits.org -->
<!-- Commit types:
https://github.com/insurgent-lab/conventional-changelog-preset#commit-types-->

## Description

<!--- Describe your changes in detail -->
BREAKING CHANGE: Removed the ability to execute system commands using
string-based inputs. This eliminates the dependency on `child_process`,
improving browser compatibility. Users relying on this functionality
should migrate to executing commands manually within their own
implementations.
## Related Issue

<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an
issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps
to reproduce -->
<!--- Please link to the issue here: -->
#967
## Motivation and Context

<!--- Why is this change required? What problem does it solve? -->
Running node-cron in a browser-based environment.
## How Has This Been Tested?

<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots (if appropriate):

## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ X ] Breaking change (fix or feature that would cause existing
functionality to change)

## Checklist:

<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->

- [ X ] My code follows the code style of this project.
- [ X ] My change requires a change to the documentation.
- [ X ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ X ] All new and existing tests passed.
- [ X ] If my change introduces a breaking change, I have added a `!`
after the type/scope in the title (see the Conventional Commits
standard).

Co-authored-by: Brandon der Blätter <intcreator@users.noreply.github.com>
@intcreator intcreator merged commit 69cb9e6 into beta Apr 19, 2025
15 checks passed
@ncb000gt
Copy link
Member

🎉 This PR is included in version 5.0.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

intcreator pushed a commit that referenced this pull request Jun 5, 2025
## [5.0.0-beta.1](v4.3.0...v5.0.0-beta.1) (2025-04-19)

### ⚠ Breaking changes

* Removed the ability to execute system commands using
string-based inputs. This eliminates the dependency on `child_process`,
improving browser compatibility. Users relying on this functionality
should migrate to executing commands manually within their own
implementations.
## Related Issue

<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an
issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps
to reproduce -->
<!--- Please link to the issue here: -->

### ✨ Features

* remove `child_process` dependency for browser compatibility (#… ([#982](#982)) ([69cb9e6](69cb9e6)), closes [#967](#967)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants