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

Split the examples from this repo #5309

Open
UlisesGascon opened this issue Nov 11, 2023 · 8 comments
Open

Split the examples from this repo #5309

UlisesGascon opened this issue Nov 11, 2023 · 8 comments
Assignees

Comments

@UlisesGascon
Copy link
Member

I was thinking that maybe makes sense to separate the examples from this repo.

There are some cases when CVEs impact some of the examples and the dependencies upgrade are incompatible with the CI (see: #5237).

What do you think? (cc: @dougwilson @expressjs/triagers )

@dougwilson
Copy link
Contributor

Ya, I agree. I believe there is an issue about this somewhere. There are a bunch of code paths only exercised by the examples, which is why they have not been split. We need to replicate the gaps into our tests directly so we can move the examples to a diff repo and not rely om their tests here for code coverage.

@UlisesGascon
Copy link
Member Author

I can create a repository (fork express) and clean up the repo to keep only the examples and the related tests (without breaking Git History). Then we can migrate that repo to the expressjs org.

That way we can move the PRs that are related to the examples without breaking the contributors experience. Also we can tweak the CI pipeline to use current/LTS Node.js versions and latest Express version.

Can I start working on this @dougwilson?

@dougwilson
Copy link
Contributor

Sure! I wouldn't bother trying to keep all this repo history in there. Just a clean repo is fine. Just a copy of what is in master and their tests ro start and then we can iterate from there. I made https://github.com/expressjs/examples let me know if u cannot make a pr against an empty repo and I can add a readme

@UlisesGascon
Copy link
Member Author

I just created this PR #5311 and this repo https://github.com/ulisesgascon/express-examples/. I will give you admin access so you can migrate it to the org as https://github.com/expressjs/examples. Sorry for the mess 😅

@UlisesGascon
Copy link
Member Author

@dougwilson you can use this link to access to my repo as admin so you can transfer it.

Also I can ask for a transfer using the GIthub UI:

Screenshot 2023-11-20 at 12 40 30

let me know if what you prefer.

@bjohansebas
Copy link
Member

What has happened with that repository?

@wesleytodd
Copy link
Member

I don't think we ever created the repo did we?

I was looking for this because I was starting to formulate the plan around benchmarks, and it seems like a lot of the "examples" double as benchmarks starters. I would be happy to group some of the example work into the performance benchmarks if that worked for others. I for sure want us to have some benchmarks that test express apps which are using common middleware and best practices.

Seems to me like the best next step for this would be to make the repo? Porting things over might take a minute since we need to figure out what technical goals we have for the new repo. But I dont see anything blocking us from making the repo if we agree they should not live in the express repo directly?

@bjohansebas
Copy link
Member

It was created, long before i asked what happened with that repository, just that someone deleted it.

Sounds good to recreate it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants