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

adborroto/PG 62 convert to typescript #23

Merged
merged 10 commits into from
Oct 7, 2024

Conversation

adborroto
Copy link
Contributor

@adborroto adborroto commented Oct 4, 2024

Note - Since this is a public repository, make sure that we're not publishing private data in the code, commit comments, or this PR.

Note for reviewers - Please add a 2nd reviewer if the PR affects more than 15 files or 100 lines (not counting
package-lock.json), if it incurs significant risk, or if it is going through a 2nd review+fix cycle.

📚 Context/Description Behind The Change

  • Remove ava and add jest
  • Modify unit test to be compatible with jest
  • Typescripify the package
  • Modify README

🚨 Potential Risks & What To Monitor After Deployment

Verify that is compatible with previous versions. I bump up compatibility just in case. I will generate and alpha release to test the changes

🧑‍🔬 How Has This Been Tested?

  • Prepare alpha release
  • Test the package with new changes
  • Verify pipeline works

🚚 Release Plan

Test & Release

Signed-off-by: Alejandro Dominguez <[email protected]>
BREAKING CHANGE:

Signed-off-by: Alejandro Dominguez <[email protected]>
Signed-off-by: Alejandro Dominguez <[email protected]>
Signed-off-by: Alejandro Dominguez <[email protected]>
@adborroto adborroto self-assigned this Oct 4, 2024
*
* @returns {number} The number of concurrent functions.
*/
get numConcurrent(): number {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added this mostly for testing purposes.

Signed-off-by: Alejandro Dominguez <[email protected]>
Signed-off-by: Alejandro Dominguez <[email protected]>
Signed-off-by: Alejandro Dominguez <[email protected]>
Signed-off-by: Alejandro Dominguez <[email protected]>
Signed-off-by: Alejandro Dominguez <[email protected]>
Copy link
Contributor

@jsalvata jsalvata left a comment

Choose a reason for hiding this comment

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

LGTM

Left only a petty comment.

@@ -61,19 +59,17 @@ or
$ npm i @mixmaxhq/promise-pool
```

Changelog
---------
## Changelog
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we update this? Or remove it altogether, if we'll be maintaining a CHANGELOG file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we should yes. But I don't know how to publish this package. Should I do it manually ?
@bradvogel do you know?, last release was 5y ago.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yup, the old school way :-/. This repo doesn't have semantic-release that auto-publishes.

You should be able to run mixmax dev npm publish (instructions here) which runs this script.

package.json Outdated
"@types/jest": "^28.1.3",
"@typescript-eslint/eslint-plugin": "^4.33.0",
"@typescript-eslint/parser": "^4.33.0",
"babel-cli": "^6.26.0",
Copy link
Contributor

Choose a reason for hiding this comment

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

Babel can be removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Solved!

@@ -61,19 +59,17 @@ or
$ npm i @mixmaxhq/promise-pool
```

Changelog
---------
## Changelog
Copy link
Contributor

Choose a reason for hiding this comment

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

Yup, the old school way :-/. This repo doesn't have semantic-release that auto-publishes.

You should be able to run mixmax dev npm publish (instructions here) which runs this script.

Signed-off-by: Alejandro Dominguez <[email protected]>
@adborroto adborroto merged commit d167b56 into master Oct 7, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants