Skip to content
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

enhancement/readme-and-changelog-update #526

Merged
merged 1 commit into from
May 16, 2024

Conversation

PaulDalek
Copy link
Contributor

Updated README, CHANGELOG and Puppeteer version.

@PaulDalek PaulDalek requested a review from cvasseng May 16, 2024 12:19
@PaulDalek PaulDalek self-assigned this May 16, 2024
@PaulDalek PaulDalek requested a review from jszuminski May 16, 2024 14:04
Copy link
Contributor

@jszuminski jszuminski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@PaulDalek PaulDalek merged commit c2348b1 into master May 16, 2024
2 checks passed
@PaulDalek PaulDalek deleted the enhancement/readme-and-changelog-update branch May 16, 2024 14:19
@bvogel
Copy link

bvogel commented May 16, 2024

Question: the README now mentions "The v4 introduces numerous breaking changes", however the CHANGELOG only has New Features, Enhancements and Fixes. Could the CHANGELOG please clearly mark what changes are breaking?

@bvogel
Copy link

bvogel commented May 17, 2024

After reading the CHANGELOG several times, are these the breaking changes:

- Changed the customCode section of options to customLogic in order to avoid confusion with the existing customCode property within.
- Renamed the environment variables for a better representation of their roles (refer to all envs in the README's Environment Variables section).
- Renamed the HIGHCHARTS_MODULES and HIGHCHARTS_INDICATORS environment variables respectively to HIGHCHARTS_MODULE_SCRIPTS and HIGHCHARTS_INDICATOR_SCRIPTS.
- Renamed the scripts property of the config options to customScripts.
- Renamed the initPool function to initExport in the main module.
- Renamed the init function to initPool in the pool module.
- Renamed the environment variable POOL_LISTEN_TO_PROCESS_EXITS to OTHER_LISTEN_TO_PROCESS_EXITS.
- Moved the listenToProcessExits from the pool to the other section of the options.

If so, I don't think many users will be affected, however they should be their own section in the changelog?

@PaulDalek
Copy link
Contributor Author

PaulDalek commented May 23, 2024

@bvogel Most of the breaking changes relate to name changing of some properties and envs, yes. But there are also many others included in the CHANGELOG.

I don't think many users will be affected

Probably but some might be, therefore the info.

@bvogel
Copy link

bvogel commented May 27, 2024

As we a currently affected by #523 in our production system - how far away are we from a new (beta/rc) release? If there is no immediate time planed we might want to look to use the current master/main branch as gem (which we really don't want to do...)

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