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

Fix build failure in node.js example #4394

Merged
merged 5 commits into from
Sep 13, 2024

Conversation

Johennes
Copy link
Contributor

@Johennes Johennes commented Sep 9, 2024

Relates to: #4287
Relates to: element-hq/element-web#26922
Signed-off-by: Johannes Marbach [email protected]

Checklist

  • Tests written for new code (and old code if feasible).
  • New or updated public/exported symbols have accurate TSDoc documentation.
  • Linter and other CI checks pass.
  • Sign-off given on the changes (see CONTRIBUTING.md).

Relates to: element-hq/element-web#26922
Signed-off-by: Johannes Marbach <[email protected]>
@github-actions github-actions bot added the Z-Community-PR Issue is solved by a community member's PR label Sep 9, 2024
"dependencies": {
"cli-color": "^1.0.0",
"matrix-js-sdk": "^32.0.0"
"matrix-js-sdk": "^34.5.0-rc.0"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Would be nice to install the SDK from file:../.. instead and then do something on the CI to verify it doesn't regress again. I couldn't think of a good way to do that though.

Copy link
Member

Choose a reason for hiding this comment

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

I'm torn on this. On the one hand, I'd like to set an example of how you might actually depend on the js-sdk in a project, which points towards an explicit version requirement here. On the other hand, I'd like to make sure that the examples continue to work as the js-sdk evolves, pointing towards file:./...

Maybe we can use an explicit version, but keep it up-to-date with Renovate?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds like a good compromise, yes. I'm slightly rusty on Renovate. It doesn't look like the example is currently picked up in the dashboard. I assume this is due to https://github.com/matrix-org/renovate-config-element-web/blob/main/default.json#L22. How exactly do we override this via the renovate.json in this repository? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Or actually, I guess we can just add this into https://docs.renovatebot.com/configuration-options/#filematch? Is there a way to test this without merging to develop?

Copy link
Member

Choose a reason for hiding this comment

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

I have honestly no idea. Renovate is a mystery to me.

@Johennes Johennes marked this pull request as ready for review September 9, 2024 15:16
@Johennes Johennes requested a review from a team as a code owner September 9, 2024 15:16
@richvdh richvdh self-requested a review September 10, 2024 13:13
examples/node/app.js Show resolved Hide resolved
examples/node/app.js Show resolved Hide resolved
examples/node/app.js Outdated Show resolved Hide resolved
"dependencies": {
"cli-color": "^1.0.0",
"matrix-js-sdk": "^32.0.0"
"matrix-js-sdk": "^34.5.0-rc.0"
Copy link
Member

Choose a reason for hiding this comment

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

I'm torn on this. On the one hand, I'd like to set an example of how you might actually depend on the js-sdk in a project, which points towards an explicit version requirement here. On the other hand, I'd like to make sure that the examples continue to work as the js-sdk evolves, pointing towards file:./...

Maybe we can use an explicit version, but keep it up-to-date with Renovate?

examples/node/package.json Outdated Show resolved Hide resolved
Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

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

LGTM for now at least

@richvdh richvdh changed the title Fix node.js example Fix build failure in node.js example Sep 13, 2024
@richvdh richvdh added the T-Task Tasks for the team like planning label Sep 13, 2024
@richvdh richvdh enabled auto-merge September 13, 2024 15:35
@richvdh richvdh added this pull request to the merge queue Sep 13, 2024
Merged via the queue into matrix-org:develop with commit c8403f3 Sep 13, 2024
31 of 32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-Task Tasks for the team like planning Z-Community-PR Issue is solved by a community member's PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants