All,
I have been trying to keep track of everything that needs to be done to
get the WebSocket API code into a state where we can releases it. I
thought the community would find the following summary of progress useful.
Thank you for that.
(I'm mostly moved into my new place and have internet again)
My working assumptions are:
- the release will be performed by the Jenkins release job from the
EE4J_8 branch
The initial release yes.
The branch name is one of the inputs in the release process.
Future releases will probably be from other branches.
- it is very preferable to keep master and EE4J_8 in sync
Can you explain why you think this is necessary?
After the initial release, I don't envision EE4J_8 having much more activity.
The future after the initial release will be in a new branch, right?
- CI should test minimum required Java version (6) and latest
Unfortunately we don't have much control over the CI environment.
There are a number of Java VM's we can use that are considered "pre installed".
These are hinted at by Mikaël Barbero in his email to ee4j-build ...
The filesystem locations for them are still a mystery to me (currently).
If we have a specific jdk we want to build against, I can track it down for updating the release scripts.
- changes that alter the API and/or documented behaviour are not
acceptable in this release
Yeah, that's unfortunate.
- clean-up is desirable but not essential
I see general javadoc syntax cleanup being important (as the newer javadoc doclint is FAR more strict to the W3C HTML 4.01 HTML standard)
- we need to follow the various Eclipse policies and PMC directives
I think we have most of the policies and PMC directives already covered.
The only one I haven't verified is the LICENSE and NOTICE file within the META-INF directory of the archives.
Can you think of any others we've missed?
So, on the progress summary.
Complete for master and EE4J:
- correct min java version
- No automatic module name is defined (NB this requirement might change)
Complete for master:
- groupId/artifactId
- required legal docs (NOTICE, LICENSE, CONTIBUTING) are present
- copyright notices updated where required
- CI running and passing for min Java version
- CI running and passing for latest Java version
- CI copyright check passes
- .gitignore has been added
- Fixed Javadoc warnings
- Fixed IDE warnings
Things we have to do before we can release:
- version is correct (3.0.2-SNAPSHOT) (PR #276)
- latest parent POM (1.0.2) is being used (PR #276)
- CI release build running and passing (PR #276)
Things that would be nice to have in the release:
- Re-check formatting against provided Eclipse formatter
In short, we need to apply PR #267 (an approval is required) and then
merge all the changes from master to EE4J and we should be ready for the
release.
If so, it's approved.
(we should either fix or remove the travis build on websocket-api, to get rid of those PR errors)
Mark
_______________________________________________
websocket-dev mailing list
websocket-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/websocket-dev
