Skip to content

Split examples from Express Core - #5311

Draft
UlisesGascon wants to merge 3 commits into
expressjs:masterfrom
UlisesGascon:feat/split-examples
Draft

Split examples from Express Core#5311
UlisesGascon wants to merge 3 commits into
expressjs:masterfrom
UlisesGascon:feat/split-examples

Conversation

@UlisesGascon

Copy link
Copy Markdown
Member

This is an initial approach to #5309 (cc: @dougwilson ). All feedback is super welcome. 🙌

What is this about?

The main idea is to remove the /examples and the related tests from this repository and relocate them in https://github.com/expressjs/examples

This PR will remove the /examples/** (a13e252) and /test/acceptance/** (555e726) from this repo and update the documentation regarding the examples to point out the new repository to the users (d9da9ad)

What are the dependencies for this PR?

This PR won't make sense unless we transfer my repository https://github.com/UlisesGascon/express-examples to the express org as https://github.com/expressjs/examples.

The other repo has the same git historial as this repo and the Express core stuff have been removed, so only the examples and the acceptance tests are there. See UlisesGascon/express-examples#1 for more details.

What will happen with the PRs related to examples?

Well, the idea is to port them (as both repos have the same history). As an example I port one commit (UlisesGascon/express-examples@51db5b6 from #5190) in this PR: UlisesGascon/express-examples#3

@UlisesGascon

Copy link
Copy Markdown
MemberAuthor

I will move this PR to draft again, as I want to include a pipeline to support integration tests again.

@UlisesGascon
UlisesGascon marked this pull request as draft February 18, 2024 14:15
@UlisesGasconUlisesGascon added the semver-ignore This change does not have any impact in semver (docs, tooling, etc..) label Apr 17, 2024
@IamLizu

Copy link
Copy Markdown
Member

Perhaps we can avoid integration testing by introducing mutation testing. It would benefit us in two ways,

  1. clean repo, no examples in the core
  2. strong test suites, making sure the test cases are solid for scenarios when code is changed in a place we don't want and the test doing what it should

ref: expressjs/discussions#269

@nidhishgajjar

This comment was marked as spam.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

semver-ignoreThis change does not have any impact in semver (docs, tooling, etc..)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@UlisesGascon@IamLizu@nidhishgajjar