Page MenuHomeSoftware Heritage

Release swh-graph 0.0.2
ClosedPublic

Authored by haltode on Fri, Aug 23, 11:59 AM.

Details

Summary

Once this diff is accepted/merged, I will push a new tag and this
should trigger PyPi automatic publication.

Diff Detail

Repository
rDGRPH Graph service
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

haltode created this revision.Fri, Aug 23, 11:59 AM
zack requested changes to this revision.Fri, Aug 23, 12:43 PM

We certainly don't want to modify all Java files at each release.
So please either fix it the right way (which would probably mean some git subst var hackery) or at least for now just get rid of the version numbers from all Java source code - it's useless information anyway, as it belongs to the underlying VCS.

I'm also disturbed by the version number in the README, it would be better to have an indirection there (a generated symlink?). But it's a minor point.

This revision now requires changes to proceed.Fri, Aug 23, 12:43 PM
haltode added a comment.EditedFri, Aug 23, 12:58 PM
In D1908#44068, @zack wrote:

We certainly don't want to modify all Java files at each release.
So please either fix it the right way (which would probably mean some git subst var hackery) or at least for now just get rid of the version numbers from all Java source code - it's useless information anyway, as it belongs to the underlying VCS.

The "automatic" way is javadoc macro that updates the doc version each time it is modified, but I can also remove version and since attributes.

I'm also disturbed by the version number in the README, it would be better to have an indirection there (a generated symlink?). But it's a minor point.

I can modify the pom.xml such as suggested in https://stackoverflow.com/a/2225259 to have target/swh-graph-jar-with-dependencies.jar.

zack added a comment.Fri, Aug 23, 2:32 PM

The "automatic" way is javadoc macro that updates the doc version each time it is modified, but I can also remove version and since attributes.

Please do (remove them).

I'm also disturbed by the version number in the README, it would be better to have an indirection there (a generated symlink?). But it's a minor point.

I can modify the pom.xml such as suggested in https://stackoverflow.com/a/2225259 to have target/swh-graph-jar-with-dependencies.jar.

There's value in having a versioned .jar. For instance, we certainly want to publish that on PyPI, rather than a versionless one.
It's just that user manual instructions shouldn't force users to type the version number.
I didn't read all that thread (sorry), but if we can have both, why not.

haltode updated this revision to Diff 6406.Fri, Aug 23, 7:08 PM

Remove @version and @since tags

zack accepted this revision.Fri, Aug 23, 7:09 PM
This revision is now accepted and ready to land.Fri, Aug 23, 7:09 PM

For the symlink part, the stackoverflow post I linked was only for the jar without dependencies so it could not work. I tried with exec-maven-plugin but could not get it to bind at the end of Maven lifecycle...

This revision was landed with ongoing or failed builds.Fri, Aug 23, 7:10 PM
Closed by commit rDGRPHb6c6e1eec131: release 0.0.2 (authored by haltode). · Explain Why
This revision was automatically updated to reflect the committed changes.