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
Use boolean flag to create apidoc menu #3443
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. And allowing apidocurl, etc. to be unspecified should make it easier for VSNetBeans to use its own json file and leave out a bunch of stuff it doesn't need?
@JaroslavTulach please can we get a vsnetbeansrelease.json
for the upcoming VSNetBeans release? Will simplify things with out of band releases. Should just be a case of overriding the default json file property somewhere in the build files.
// remove empty api doc | ||
ri.removeIf(e -> e.apidocurl.isEmpty()); | ||
//ri.removeIf(e -> e.apidocurl.isEmpty()); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just spent 15min looking for the build issue that @JaroslavTulach had with older VSNetBeans release to realise it's already covered by this change! 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JaroslavTulach please can we get a
vsnetbeansrelease.json
for the upcoming VSNetBeans release?
See apache/netbeans-jenkins-lib#46 - I am particularly afraid of duplicating the same data in two files for 12.5.0
, 12.6.0
, etc. releases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JaroslavTulach normally I'd be the first to agree with you on data duplication, but as also mentioned there, we're losing the canonical record of Apache IDE releases in that file, which is also important because it's used elsewhere. Let's keep conversation on that there.
This is the current build configuration for VSNetBeans:
I can certainly change |
Yes, looking at that I guess changing $METAURL will have to do. I was thinking there was an Ant file inside |
@ebarboni if we keep the VSNetBeans releases in the same json file, a flag to pick up what is and isn't an IDE release might be useful for this and other problems. On the other hand, that would still involve VSNetBeans having to configure the build differently, so still probably better as a separate file IMO. |
this pr is more for cleaning up apidoc once done on other release branches, If we add some flag on the json, (non impacting the netbeans repo) we may also have for example in the release branches Will have impact on https://github.com/apache/netbeans-jenkins-lib/blob/master/vars/asfMainNetBeansBuild.groovy that is old and can be upgraded to fit |
Yes, I understand that. Still all easier with separate JSON files. There's the other stuff on the VM that reads the JSON file too - I just realised I don't think you had the current |
My bad, I use the content from the PR on netbeans-tools. PR created to resynchronize. I put do not merge because of this: I would prefer one file to keep all what is build on netbeans repo because if we need management. Thinking on release removal, it will involve recomputing date to get apichangelog and I would prefer one place for that. |
@ebarboni definitely my bad! 😄 I'd meant to update that PR with my changes. The problem is how many places we're going to have to build in logic to filter by release type. I realise there's no right answer here - both have problems. |
in fact "publish_apidoc":"false" is kind of "vsix_only":"true" so we can filter the list no using another boolean. for the build in https://github.com/apache/netbeans-jenkins-lib/blob/master/vars/asfMainNetBeansBuild.groovy this is up to us. (Will try to make that possible so we can have common way on "X.X release" and for the X.X.301) for apidoc with the new flag we just avoid curl 404 in the vm if we patch to scan for the publish flag. I'm not sure the other place where we use the json. |
Well, from 13 we'll have X (and X.301 potentially). I'm still curious to see what that breaks! 😄 That 404 took out the entire Javadoc publishing process if I remember rightly. I don't know what the other places we use the json are, or what we might need in future - that's my concern. And if we start filtering for this flag inside the build, then VSNetBeans will still have to special case it. |
version X worked for 10, just the apidoc/update catalog need the X.0 |
Thanks! Let's see how we get on with this. Let's take the flags discussion elsewhere. Having thought on this, I think if we do keep in one file, we need two truth-y values for |
attempt to make apidoc generation according to a flag instead of url.
remove apidoc prior to 8.2 link
will need to recommit on the previous release branch.