unitsofmeasurement / seshat

Seshat Units of Measurement Implementation
Apache License 2.0
7 stars 3 forks source link

Create web site #12

Closed desruisseaux closed 4 years ago

desruisseaux commented 5 years ago

Hello @keilw. Should we create a web site on https://unitsofmeasurement.github.io/seshat with Javadoc? If yes, then if I understood correctly the process would be:

  1. Create an orphan branch with git checkout --orphan gh-pages.
  2. Commit a home page and javadoc on that branch.
  3. Other action needed?

Any recommendation?

desruisseaux commented 5 years ago

Created the branch on https://github.com/unitsofmeasurement/seshat/tree/gh-pages for testing purpose. Waiting to see if the index.html page appears after some time.

desruisseaux commented 5 years ago

I guess that enabling those pages would require someone with administrative privilege (I do not have). @keilw could you take a loot under the "Setting" tab please (if you agree)?

keilw commented 5 years ago

Have to check later when I'm on my own PC. If admin rights can be added to a particular repo, @desruisseaux will get it here. P.s.: what about the TCK, I understand, Seshat may always have problems with those 2 tests that fail as in https://117-41443578-gh.circle-artifacts.com/0/home/circleci/repo/target/tck-output/emailable-report.html? For JSR 363 I would not necesarily change it unless you think Seshat may take many more months before it can also implement 385, but since equals() and hashCode() are not vital parts of our actual API I would say removing those two for the Quantity check should be acceptable without affecting the value of the TCK.

desruisseaux commented 5 years ago

I was not aware of those two test failures, thanks for spotting them. I will check. Are those tests run automatically when new commits are pushed?

I just saw you comment about the TCK test failures on issue #7. Sorry for having missed it.

keilw commented 5 years ago

Yes the current Seshat version fails the TCK (of JSR 363). I don't know, if any reasonable change could be made to address that e.g. take equals and hashcode into consideration, but if you can, please do, otherwise we may have to discuss excluding certain tests (as this was the case for Jakarta EE recently ;-)

Ideally the links in the organisation site should also contain a page with compatible implementations, even if several are created by the wider team, so people have a choice.

desruisseaux commented 4 years ago

Hello @keilw. If you have a chance, can you take a look at the "Settings" tab of Seshat, scroll down to "GitHub Pages" and verify that "hg-pages branch" is selected? I would like to make a web site alive if possible.

keilw commented 4 years ago

I hope "hg-pages" was a typo? Will have a look, is the 1.0 release also going to be on MavenCentral or another repository? We have a bit of a backlog with conferences or interviews in recent weeks, but happy to also mention the Seshat 1.0 news in the general Blog/News section.

desruisseaux commented 4 years ago

Yes, hg was a typo - I mean gh-pages, thanks for spotting that.

It would be nice if it could be distributed on Maven Central (task #13), but I think only you can do that as the owner of tech.uom group ID?

keilw commented 4 years ago

That is quite possible, if you have a bintray account, I'd be happy to add you to the UoM organization, but for Sonatype they have their own credentials and access tickets, mine works there, so I am happy to deploy Seshat, if you would like to help with Bintray, tell me your account name.

desruisseaux commented 4 years ago

I'm not familiar with bintray; I have a sonatype account. But if it is easier to go through bintray, I can register there.

desruisseaux commented 4 years ago

Hello @keilw. Is there any update about the Seshat web site publishing issue? I created GitHub pages on https://github.com/unitsofmeasurement/seshat/tree/gh-pages but I think we need administrator to look on https://github.com/unitsofmeasurement/seshat/settings scroll down to "GitHub" pages and ensure that "gh-pages branch" is selected.

keilw commented 4 years ago

I gave you "maintain" privileges to seshat, please try if thats's enough, it is just one notch below admin, if that does not work to publish or edit branches, let me know, then I could also try admin.

desruisseaux commented 4 years ago

A (very primitive) web site is online at https://unitsofmeasurement.github.io/seshat/. Thanks for your help!

keilw commented 4 years ago

Great it worked. Are there plans for a 1.0 GA of Seshat or even 2.x using JSR 385 any time soon?

desruisseaux commented 4 years ago

(Oups! your comment makes me realize that I deployed Javadoc from snapshot instead than 1.0 release - this is fixed).

1.0 GA was tagged 5 months ago actually, but have not been deployed to Maven central yet. This is the topic of #13. The main issue here is for me to learn how to do that with Bintray.

For using JSR 385, my hope is to work on it this summer. But I'm notoriously bad with delays, so it is hard to said if I will be ontime.

keilw commented 4 years ago

Ok let me know, if you need help with Bintray, e.g. creating an artifact, although that might already exist. https://github.com/unitsofmeasurement/unit-tck-usage/tree/seshat demonstrates the TCK is passed, it is a generous variation of the QUANTITY profile in the TCK, but I assume BASE_QUANTITY would pass under any circumstance because it only tests for the SI base quantities and not all that JSR 363 or 385 offer?

desruisseaux commented 4 years ago

I'm not sure what is the difference between the QUANTITY and BASE_QUANTITY profiles? The TCK 1.1 is also executed during Seshat Maven build, but no profile is specified. Running mvn test or mvn install on Seshat produces the following output:

JSR 363 TCK version 1.0.2-SNAPSHOT Summary
-------------------------------------------------------

TOTAL TESTS EXECUTED : 84
TOTAL TESTS SKIPPED  : 0
TOTAL TESTS SUCCESS  : 84
TOTAL TESTS FAILED   : 0

-- JSR 363 TCK finished --