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

Documentation: Adds missing Maven dependency version #18

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

maxkratz
Copy link

Currently, the version information for the Maven dependency is missing within the EdgeDB documentation: https://www.edgedb.com/docs/clients/java/index

This PR adds the missing version information to fix the related Maven error:

[...]
[ERROR] [ERROR] Some problems were encountered while processing the POMs:
[ERROR] 'dependencies.dependency.version' for com.edgedb:driver:jar is missing. @ line 23, column 14
[...]

@quinchs
Copy link
Collaborator

quinchs commented Aug 16, 2023

I left the version out because of doc sync, there may be moments where what it says on the docs isn't the most up-to-date version. I think we could fix this more elegantly with some website code, cc @jaclarke: is there infrastructure in place for this in other binding docs?

@maxkratz
Copy link
Author

I left the version out because of doc sync, there may be moments where what it says on the docs isn't the most up-to-date version.

Okay, this makes sense to me. Maybe we can integrate a placeholder for the version etc.?

I think we could fix this more elegantly with some website code, cc @jaclarke: is there infrastructure in place for this in other binding docs?

This would probably be the most elegant solution.

@jaclarke
Copy link
Member

jaclarke commented Aug 17, 2023

is there infrastructure in place for this in other binding docs?

Not currently, if I'm understanding right. To clarify, we want to have some kind of placeholder that gets replaced at build time with the latest version? (from I guess somewhere like the github releases api? https://api.github.com/repos/edgedb/edgedb-java/releases/latest)

Edit: Or maybe it would be easier to have as part of the publish workflow in the client repos, a step to update the version in their docs, that could then trigger the website re-deploy webhook?

@maxkratz
Copy link
Author

Any news on this? The version is still missing on the documentation page.
(I would be happy to update my PR to 0.2.3 - this would at least introduce a version to the page.)

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