APSIM Classic - process for continuous release

[sarahcleary]

For the forseeable future, the Apsim Classic release will remain at 7.10, and links to upgrade to the latest bugfix are available to developers only via the bootleg system on bob. This means registered users don't have a) knowledge of available bug fixes, and b) access to them.

@peter-devoil to work with @hol353 to propose a solution which is likely to involve version and build number. Once agreed, @sarahcleary to provide a news article and web page for process and referencing.

[sarahcleary]

Any update @peter-devoil / @hol353 ?

[sarahcleary]

Any update @peter-devoil / @hol353 ?

[peter-devoil]

Bob has been broken and unable to create releases, so nothing has happened.

[sarahcleary]

Any update @peter-devoil / @hol353 ?

[peter-devoil]

Still waiting on bob - all the PRs seem to be failing. eg APSIMInitiative/APSIM710#1746

[sarahcleary]

@peter-devoil - any update?

[sarahcleary]

relates to APSIMInitiative/APSIM710#1759
@peter-devoil - can this issue be closed?

[peter-devoil]

No, still waiting on bob to a) stamp sequence numbers on the release, and b) build things.. See APSIMInitiative/APSIM710#1757

[sarahcleary]

@peter-devoil - did you want this on the agenda for next Friday's meeting? any update?

[peter-devoil]

@sarahcleary - Status is unchanged, but minor progress on the builder. Try again next time.

[sarahcleary]

@peter-devoil - did you want this on the agenda for Thursday's meeting? any update?

[peter-devoil]

Yes, there is a minor update in that - @hol430 has got jenkins building releases again, and we now have to work out how these installation files will appear on the downloads (upgrades?) section of the website.

[hol430]

They're currently accessible on Bob's webpage. Do we want them somewhere else?

[peter-devoil]

Yes, we want a simplified list for ordinary users with a) a link to the issue, b) a link to the installer, and c) the standard disclaimer. The above has works in progress and failures - users don't want to see that - the user just wants to know of the issue that was resolved, and a link to install the fix.

I don't know whether the downloads section of apsim.info should point to an autogenerated apsimdev page; or whether @sarahcleary should periodically update a page in the WP site. Given that we only resolved ~6 bugs in apsim classic last year, it might be simpler to do it by hand.

[peter-devoil]

I forgot to add d) sequence numbers. They need to start somewhere after the last svn revision number so that users don't think they're going backwards.

I suspect @sarahcleary should be able to use something like this wp plugin on the main site somewhere that points to apsimdev - but I don't know whether the laborious registration procedure has to be followed?

@jbrider @hol353 @hol430 - can we meet sometime in january to sort out what has to happen here?

[jbrider]

@peter-devoil I will be available after the 13th.
I think we're going to need incrementing version numbers for both classic and nextgen.
We've already had concerns voiced by developers about the versioning being tied to the issue number - it's only going to get worse when we start getting more regular users after the symposium.

[sarahcleary]

this is still outstanding. We had intended on completing in person during APSIM week - @peter-devoil, @jbrider @hol430 - suggestions on best way to complete? teleconference?

[hol430]

I have a working prototype of this but it doesn't include the extra options for commercial users. I will add this in and then see where we're at.

[hol430]

How do you want this commercial license registration to work? I can create a separate webpage for commercial users but if many of the inputs are the same as for regular users (name, company, country, ...) then it might make more sense to use the same page. I can add a checkbox for "Download under commercial license" and by checking the checkbox, some extra inputs appear.

[sarahcleary]

@hol430 - I can't see why the same page, with a 'checkbox' can't work. As long as we can pull out the list of commercial licensees easily. @hol353; @peter-devoil - can you see any issues doing it this way?

[sarahcleary]

@hol430 - just to confirm - the prototype you talk about above, combines both issues - the one for registration and the one to allow APSIM Classic cts release. @peter-devoil - anything you wish to add/clarify?

[hol430]

What does cts stand for?

[sarahcleary]

cts - continuous

[peter-devoil]

Nothing from me - happy to wait till we get a prototype.

[hol430]

Ok - yeah, I've implemented the changes to the registration page that you wanted - although I haven't made these changes live yet. I also haven't done anything about the modified registration process for commercial users as I don't know what extra information you want. That can be considered a separate issue/change though - we can proceed with just the revamped registration process for now.

I haven't implemented an incrementing version number yet. @peter-devoil how did this work in the past? It seems to me that whenever a pull request gets merged, we would have to retest all of the other pull requests? Otherwise the version info embedded in the build artifacts would be stale.

[peter-devoil]

It was awful. Basically, every time a build was made, it ran with a candidate revision number - current + 1 . If it was accepted (passed automated tests) the build was good to go. If it failed, the installers are discarded and the build is only used for dissection.

It's getting it wrong here - the 7.7r0 bits. There was a field in the database for this iirc.

At the worst, it might mean having to do the build twice - once for testing, another for branding (with rXXXX) after the merge. I suspect we could get away without a full build, as its only the Release scripts (that create the installer) require the revision number. All the outs & sums (that have a git hash inside them) aren't included in the install.

[sarahcleary]

Drew
In addition to name, email -
We need the following information:
Licensor name (as in Company name) and if an Australian company, ABN or equivalent company registration number
Licensor’s Representative - ability to insert an additional person to be sent notices/invoices
Turnover of Licensor - this is preferably a tick box – for the turnover of the company/licensor. (see Pricing structure at bottom of this page - https://www.apsim.info/download-apsim/commercial-use/ )

[hol430]

Ok, yeah it sounds like having the release occurring as a separate job after the pull request gets merged will be the way to go. Do we want it to be like ApsimX in that a release is only generated if the pull request fixes an issue (as opposed to working on an issue)?

[peter-devoil]

Yes. Hardly anyone shares interim releases.

You could drop the release bits from buildall.xml, and add them to another that just builds the release. Or set the "target" when calling the jobscheduler executable.

[hol430]

@peter-devoil @sarahcleary I think the incrementing revision number system is now working. Whenever a pull request is merged, a "ReleaseClassic" job will be triggered on Jenkins iff the pull request fixes an issue. This ReleaseClassic job will figure out the latest revision number, brand and build apsim, and generate an installer. The bob webpage should link to this installer.

There don't appear to be many installers linked from Bob's webpage because it's been a while since someone actually fixed an issue - most of the recent pull requests have all been "working on" issues.

[peter-devoil]

Thanks drew.

[hol430]

@peter-devoil - do we want to provide Linux sfx/binaries?

[peter-devoil]

Not for UQ. @cla473 might use them?

[sarahcleary]

@peter-devoil - let me know what needs to go into a news article when you have a chance? thanks.

[hol430]

@sarahcleary @peter-devoil I have published my changes to the registration process:

• Extra options for commercial registrations
• Registering will take you directly to the downloads page (you will still receive an email containing license stuff)

Let me know if you spot anything broken or if you want anything changed

[peter-devoil]

Good stuff, drew. My immediate comments:

• we can lose the howXXX (and perfect) stuff from the dropdown menu
• would be nice if we can embed these pages/iframes in the WP site so users get consistent L&F across the apsim.info domain

[hol430]

Ok, I have ditched the howXXX stuff from the dropdown. Regarding integration into the wp site - afaik, the contents of an iframe or embed element aren't affected by the style of the document they're embedded in. Idk much about wordpress though - maybe there is a feature/plugin to work around this.

[sarahcleary]

News Article - https://www.apsim.info/no-more-major-apsim-classic-releases/

[sarahcleary]

@peter-devoil - can we close this issue?