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.

Sign up for GitHub

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

Jump to bottom

[Feature Request]: Make CI work #225

Closed
DABH opened this issue Jul 10, 2023 · 6 comments
Closed

[Feature Request]: Make CI work #225

DABH opened this issue Jul 10, 2023 · 6 comments
Labels
good first issue important

Comments

@DABH
Copy link
Contributor

DABH commented Jul 10, 2023 •
edited
Loading

🔎 Search Terms

CI, GitHub Actions, Linting

The vision

Can anyone in the community pitch in and finish the work of making our CI work?

  1. I fixed a bunch of linter errors, but there are a few more to go (just clone, npm i --dev, and npm run lint to see the list)
  2. Even once we fix the linter errors, the CI tests won't pass because a local MongoDB server needs to be running. It looks like this is achievable with GitHub Actions: https://github.com/marketplace/actions/mongodb-in-github-actions .

Would be a huge help to the community if someone could step up for this, since right now (and for a long time) we've been flying blind with releases and MongoDB compatibility/testing. Huge huge thanks to anyone able to take this on.
@curledUpSheep
Copy link
Contributor

curledUpSheep commented Jul 12, 2023 •
edited
Loading

@DABH regarding the MongoDB compatibility testing:

  • Could it be useful to use something like mongodb-memory-server so anyone (including CI) can run the tests without explicitly having MongoDB installed?
  • What versions of MongoDB need to be included in the testing? Is it sufficient to use the current latest version (6.0) or should other versions that have not yet reached end-of-life status (4.4, 5.0) be included?

@DABH
Copy link
Contributor Author

DABH commented Jul 12, 2023

Hi! On your two points:

  1. That sounds great!!
  2. Ideally I’d vote for a test matrix with 4.4, 5.0, and 6.0 (GitHub Actions makes it pretty easy to set up a matrix of tests), but if that is way too hard for whatever reason, just 6.0 is way better than nothing :)

Excited/grateful for anything you could do!!

curledUpSheep added a commit to curledUpSheep/winston-mongodb that referenced this issue Jul 13, 2023
@curledUpSheep
winstonjs#225: Fix JSDoc defaults syntax
3a9ed12
curledUpSheep added a commit to curledUpSheep/winston-mongodb that referenced this issue Jul 13, 2023
@curledUpSheep
winstonjs#225: Fix incorrect default value in JSDoc
279085f
curledUpSheep added a commit to curledUpSheep/winston-mongodb that referenced this issue Jul 13, 2023
@curledUpSheep
winstonjs#225: Make ESLint config more pagmatic
6a9fb9c
curledUpSheep added a commit to curledUpSheep/winston-mongodb that referenced this issue Jul 13, 2023
@curledUpSheep
winstonjs#225: Fix ESLint errors
c6140ab
curledUpSheep added a commit to curledUpSheep/winston-mongodb that referenced this issue Jul 13, 2023
@curledUpSheep
winstonjs#225: Add mongodb-memory-server dev dependency
e78a9bb
curledUpSheep added a commit to curledUpSheep/winston-mongodb that referenced this issue Jul 13, 2023
@curledUpSheep
winstonjs#225: Allow using process.env in tests
8b27274
curledUpSheep added a commit to curledUpSheep/winston-mongodb that referenced this issue Jul 13, 2023
@curledUpSheep
winstonjs#225: Make tests use in-memory MongoDB by default
004eb44
curledUpSheep added a commit to curledUpSheep/winston-mongodb that referenced this issue Jul 13, 2023
@curledUpSheep
winstonjs#225: Make sure 'npm test' actually finishes
5fb01b3
curledUpSheep added a commit to curledUpSheep/winston-mongodb that referenced this issue Jul 13, 2023
@curledUpSheep
winstonjs#225: Run CI against multiple MongoDB versions
d8df41d
curledUpSheep added a commit to curledUpSheep/winston-mongodb that referenced this issue Jul 13, 2023
@curledUpSheep
winstonjs#225: Log currently used MongoDB version in tests
591d805
@curledUpSheep curledUpSheep mentioned this issue Jul 13, 2023
Merged
@curledUpSheep
Copy link
Contributor

@DABH let me know what you think :) #227

curledUpSheep added a commit to curledUpSheep/winston-mongodb that referenced this issue Jul 13, 2023
@curledUpSheep
winstonjs#225: Fix small typo
e43a53c
curledUpSheep added a commit to curledUpSheep/winston-mongodb that referenced this issue Jul 13, 2023
@curledUpSheep
winstonjs#225: Don't pull Mongo binary on 'npm ci' on local
8d1bf94 
By default, mongodb-memory-server pulls in a MongoDB binary on install.
On a first run of 'npm ci', this makes npm seem to hang for no reason.
No progress bar or anything is shown either.

With this change, the MongoDB binary is only downloaded when needed.
If needed, the download happens during tests, with progress indication.
No download will happen for people using local Mongo for testing.
@DABH DABH closed this as completed in 1b0f95d Jul 13, 2023
@DABH
Copy link
Contributor Author

DABH commented Jul 13, 2023

Thank you for this heroic effort! This is really appreciated and I expect will benefit the project for years to come :)

@curledUpSheep
Copy link
Contributor

@DABH now that CI is working: any idea when a new version would be published on npm?

It would be very convenient for me to have an officially published version that includes the fix from my other recently merged PR :)

@DABH
Copy link
Contributor Author

DABH commented Jul 17, 2023

@yurijmikhalevich Could you do a minor release? It looks like I don't have write permissions on NPM. Alternatively/in addition, can you add me as a writer on npm? I thought the winston team had write access to all winston packages on npm but seems like not. Thanks in advance!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue important
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@DABH @curledUpSheep