- Release-team - mailman3.cels.anl.gov

Re: [Release-team] release notes
by Nomi Harris 23 Apr '13

23 Apr '13

On Apr 23, 2013, at 8:06 AM, "Land, Miriam L." <landml(a)ornl.gov> wrote: > I believe that the guidelines already exist: > > https://trac.kbase.us/projects/kbase/wiki/TechDocChecking > > Miriam > > From: Michael Sneddon <mwsneddon(a)lbl.gov<mailto:[email protected]>> > Date: Monday, April 22, 2013 3:58 PM > To: Nomi Harris <nlharris(a)lbl.gov<mailto:[email protected]>> > Cc: Miriam Land <landml(a)ornl.gov<mailto:[email protected]>>, "release-team(a)kbase.us<mailto:[email protected]>" <release-team(a)kbase.us<mailto:[email protected]>> > Subject: Re: [Release-team] release notes > > I don't think it has been strictly enforced in the past, but I also think we should start requiring it. I know I completely forgot to update the release notes for Trees, which I should have done... Perhaps we should provide a very simple module checklist of what we require for a module to enter the release process, really just as a guideline to help developers remember everything that needs to be done. This exists as well: https://trac.kbase.us/projects/kbase/wiki/StandardDocuments We should check that document and make sure it's up-to-date and then send out a reminder to the developers. Nomi > Some of us had started adopting the convention of placing notes in a file named RELEASE_NOTES.txt in the root directory of each module. > > > On Mon, Apr 22, 2013 at 12:52 PM, Nomi Harris <nlharris(a)lbl.gov<mailto:[email protected]>> wrote: > Yes--I didn't get a chance to discuss this during today's meeting but I would like to see release notes for the services that are included in this minor release. This would be useful both internally (for testing, as Miriam notes) and externally (so users know what has changed). > Nomi > > On Apr 22, 2013, at 12:47 PM, "Land, Miriam L." <landml(a)ornl.gov<mailto:[email protected]>> wrote: > >> All, >> >> Do we have anything like release notes for this build? For testing purposes, it would be nice to have a list of things to specifically test for. >> >> Miriam >> _______________________________________________ >> Release-team mailing list >> Release-team(a)lists.kbase.us<mailto:[email protected]> >> https://lists.kbase.us/mailman/listinfo/release-team > > _______________________________________________ > Release-team mailing list > Release-team(a)lists.kbase.us<mailto:[email protected]> > https://lists.kbase.us/mailman/listinfo/release-team >

1 0

Re: [Release-team] release notes
by Land, Miriam L. 23 Apr '13

23 Apr '13

I believe that the guidelines already exist: https://trac.kbase.us/projects/kbase/wiki/TechDocChecking Miriam From: Michael Sneddon <mwsneddon(a)lbl.gov<mailto:[email protected]>> Date: Monday, April 22, 2013 3:58 PM To: Nomi Harris <nlharris(a)lbl.gov<mailto:[email protected]>> Cc: Miriam Land <landml(a)ornl.gov<mailto:[email protected]>>, "release-team(a)kbase.us<mailto:[email protected]>" <release-team(a)kbase.us<mailto:[email protected]>> Subject: Re: [Release-team] release notes I don't think it has been strictly enforced in the past, but I also think we should start requiring it. I know I completely forgot to update the release notes for Trees, which I should have done... Perhaps we should provide a very simple module checklist of what we require for a module to enter the release process, really just as a guideline to help developers remember everything that needs to be done. Some of us had started adopting the convention of placing notes in a file named RELEASE_NOTES.txt in the root directory of each module. On Mon, Apr 22, 2013 at 12:52 PM, Nomi Harris <nlharris(a)lbl.gov<mailto:[email protected]>> wrote: Yes--I didn't get a chance to discuss this during today's meeting but I would like to see release notes for the services that are included in this minor release. This would be useful both internally (for testing, as Miriam notes) and externally (so users know what has changed). Nomi On Apr 22, 2013, at 12:47 PM, "Land, Miriam L." <landml(a)ornl.gov<mailto:[email protected]>> wrote: > All, > > Do we have anything like release notes for this build? For testing purposes, it would be nice to have a list of things to specifically test for. > > Miriam > _______________________________________________ > Release-team mailing list > Release-team(a)lists.kbase.us<mailto:[email protected]> > https://lists.kbase.us/mailman/listinfo/release-team _______________________________________________ Release-team mailing list Release-team(a)lists.kbase.us<mailto:[email protected]> https://lists.kbase.us/mailman/listinfo/release-team

1 0

Re: [Release-team] release notes
by Nomi Harris 22 Apr '13

22 Apr '13

On Apr 22, 2013, at 1:58 PM, Thomas Brettin <brettin(a)mcs.anl.gov> wrote: > I think the time to collect this data is when we schedule something for the release. We just ask what changed. When they reply, we ask them if they can paste it into the release notes file or some other location. I'll do this next week. Ok, sounds reasonable. Ideally, we'd have a more complete list of what's changed for internal use, with a subset of that list communicated to external users, because there's stuff that affects us internally but won't affect outside users. But maybe that's getting too complicated. Nomi > > For genome annotation: what changed is the urls were changed to use 'base.us' the production servers as well as the protocol was switched from http to https. > > > Tom > > > > On Apr 22, 2013, at 2:58 PM, Michael Sneddon <mwsneddon(a)lbl.gov> wrote: > >> I don't think it has been strictly enforced in the past, but I also think we should start requiring it. I know I completely forgot to update the release notes for Trees, which I should have done... Perhaps we should provide a very simple module checklist of what we require for a module to enter the release process, really just as a guideline to help developers remember everything that needs to be done. >> >> Some of us had started adopting the convention of placing notes in a file named RELEASE_NOTES.txt in the root directory of each module. >> >> >> On Mon, Apr 22, 2013 at 12:52 PM, Nomi Harris <nlharris(a)lbl.gov> wrote: >> Yes--I didn't get a chance to discuss this during today's meeting but I would like to see release notes for the services that are included in this minor release. This would be useful both internally (for testing, as Miriam notes) and externally (so users know what has changed). >> Nomi >> >> On Apr 22, 2013, at 12:47 PM, "Land, Miriam L." <landml(a)ornl.gov> wrote: >> >> > All, >> > >> > Do we have anything like release notes for this build? For testing purposes, it would be nice to have a list of things to specifically test for. >> > >> > Miriam >> > _______________________________________________ >> > Release-team mailing list >> > Release-team(a)lists.kbase.us >> > https://lists.kbase.us/mailman/listinfo/release-team >> >> _______________________________________________ >> Release-team mailing list >> Release-team(a)lists.kbase.us >> https://lists.kbase.us/mailman/listinfo/release-team >> >> _______________________________________________ >> Release-team mailing list >> Release-team(a)lists.kbase.us >> https://lists.kbase.us/mailman/listinfo/release-team > > _______________________________________________ > Release-team mailing list > Release-team(a)lists.kbase.us > https://lists.kbase.us/mailman/listinfo/release-team

1 0

Re: [Release-team] release notes
by Thomas Brettin 22 Apr '13

22 Apr '13

I think the time to collect this data is when we schedule something for the release. We just ask what changed. When they reply, we ask them if they can paste it into the release notes file or some other location. I'll do this next week. For genome annotation: what changed is the urls were changed to use 'base.us' the production servers as well as the protocol was switched from http to https. Tom On Apr 22, 2013, at 2:58 PM, Michael Sneddon <mwsneddon(a)lbl.gov> wrote: > I don't think it has been strictly enforced in the past, but I also think we should start requiring it. I know I completely forgot to update the release notes for Trees, which I should have done... Perhaps we should provide a very simple module checklist of what we require for a module to enter the release process, really just as a guideline to help developers remember everything that needs to be done. > > Some of us had started adopting the convention of placing notes in a file named RELEASE_NOTES.txt in the root directory of each module. > > > On Mon, Apr 22, 2013 at 12:52 PM, Nomi Harris <nlharris(a)lbl.gov> wrote: > Yes--I didn't get a chance to discuss this during today's meeting but I would like to see release notes for the services that are included in this minor release. This would be useful both internally (for testing, as Miriam notes) and externally (so users know what has changed). > Nomi > > On Apr 22, 2013, at 12:47 PM, "Land, Miriam L." <landml(a)ornl.gov> wrote: > > > All, > > > > Do we have anything like release notes for this build? For testing purposes, it would be nice to have a list of things to specifically test for. > > > > Miriam > > _______________________________________________ > > Release-team mailing list > > Release-team(a)lists.kbase.us > > https://lists.kbase.us/mailman/listinfo/release-team > > _______________________________________________ > Release-team mailing list > Release-team(a)lists.kbase.us > https://lists.kbase.us/mailman/listinfo/release-team > > _______________________________________________ > Release-team mailing list > Release-team(a)lists.kbase.us > https://lists.kbase.us/mailman/listinfo/release-team

1 0

Re: [Release-team] of special interest to test
by Thomas Brettin 22 Apr '13

22 Apr '13

I don't know. They are scripts. Tom On Apr 22, 2013, at 2:48 PM, "Land, Miriam L." <landml(a)ornl.gov> wrote: > Are they all called by 'make test'? > > Miriam > > On 4/22/13 12:34 PM, "Thomas Brettin" <brettin(a)mcs.anl.gov> wrote: > >> Hi Miriam, >> >> Here is the list of files that I modified in the genome_annotation module >> this morning. They should be tested more rigorously than just ensuring >> that the script returns 0. >> >> Chris, I'm including you because these are related to your bootcamps. The >> change could be in production by the end of this week. >> >> Tom >> >> # modified: recompile_typespec >> # modified: scripts/annotate_genome.pl >> # modified: scripts/assign_functions_to_CDSs.pl >> # modified: scripts/call_CDSs.pl >> # modified: scripts/call_CDSs_by_glimmer.pl >> # modified: scripts/call_CDSs_by_projection.pl >> # modified: scripts/call_RNAs.pl >> # modified: scripts/call_pyrrolysoproteins.pl >> # modified: scripts/call_selenoproteins.pl >> # modified: scripts/cs_to_genome.pl >> # modified: scripts/fasta_to_genome.pl >> # modified: scripts/genomeTO_strep_pneumo_repeats.pl >> # modified: scripts/genomeTO_strep_suis_repeats.pl >> # modified: scripts/genomeTO_to_coding_regions.pl >> # modified: scripts/genomeTO_to_feature_data.pl >> # modified: scripts/genomeTO_to_reconstructionTO.pl >> # modified: scripts/merge_features.pl >> # modified: scripts/reconstructionTO_to_roles.pl >> # modified: scripts/reconstructionTO_to_subsystems.pl >

1 0

Re: [Release-team] release notes
by Michael Sneddon 22 Apr '13

22 Apr '13

I don't think it has been strictly enforced in the past, but I also think we should start requiring it. I know I completely forgot to update the release notes for Trees, which I should have done... Perhaps we should provide a very simple module checklist of what we require for a module to enter the release process, really just as a guideline to help developers remember everything that needs to be done. Some of us had started adopting the convention of placing notes in a file named RELEASE_NOTES.txt in the root directory of each module. On Mon, Apr 22, 2013 at 12:52 PM, Nomi Harris <nlharris(a)lbl.gov> wrote: > Yes--I didn't get a chance to discuss this during today's meeting but I > would like to see release notes for the services that are included in this > minor release. This would be useful both internally (for testing, as Miriam > notes) and externally (so users know what has changed). > Nomi > > On Apr 22, 2013, at 12:47 PM, "Land, Miriam L." <landml(a)ornl.gov> wrote: > > > All, > > > > Do we have anything like release notes for this build? For testing > purposes, it would be nice to have a list of things to specifically test > for. > > > > Miriam > > _______________________________________________ > > Release-team mailing list > > Release-team(a)lists.kbase.us > > https://lists.kbase.us/mailman/listinfo/release-team > > _______________________________________________ > Release-team mailing list > Release-team(a)lists.kbase.us > https://lists.kbase.us/mailman/listinfo/release-team >

1 0

Re: [Release-team] release notes
by Nomi Harris 22 Apr '13

22 Apr '13

Well, we had a (somewhat arbitrary) convention that release notes are put in a file called RELEASE_NOTES.txt in the main directory of the git repo. We introduced the idea of release notes at the November build but didn't end up enforcing them because release notes are not very useful for an initial release. They are, however, very useful for subsequent releases, like this one. I don't have a strong opinion about where the release notes should go or what they should be called, or whether they should all be concatenated in one big file or be separate files for each release. Maybe Mike has opinions? However, I do think the release notes should be compiled by the developers, not by the build teams. Only the developers know exactly what they've changed. Nomi On Apr 22, 2013, at 12:54 PM, "Land, Miriam L." <landml(a)ornl.gov> wrote: > If we had them, where is the right place to document and communicate them? > At times we have used the spreadsheet for this. > > Miriam > > On 4/22/13 3:52 PM, "Nomi Harris" <nlharris(a)lbl.gov> wrote: > >> Yes--I didn't get a chance to discuss this during today's meeting but I >> would like to see release notes for the services that are included in >> this minor release. This would be useful both internally (for testing, as >> Miriam notes) and externally (so users know what has changed). >> Nomi >> >> On Apr 22, 2013, at 12:47 PM, "Land, Miriam L." <landml(a)ornl.gov> wrote: >> >>> All, >>> >>> Do we have anything like release notes for this build? For testing >>> purposes, it would be nice to have a list of things to specifically test >>> for. >>> >>> Miriam

1 0

Re: [Release-team] release notes
by Land, Miriam L. 22 Apr '13

22 Apr '13

If we had them, where is the right place to document and communicate them? At times we have used the spreadsheet for this. Miriam On 4/22/13 3:52 PM, "Nomi Harris" <nlharris(a)lbl.gov> wrote: >Yes--I didn't get a chance to discuss this during today's meeting but I >would like to see release notes for the services that are included in >this minor release. This would be useful both internally (for testing, as >Miriam notes) and externally (so users know what has changed). > Nomi > >On Apr 22, 2013, at 12:47 PM, "Land, Miriam L." <landml(a)ornl.gov> wrote: > >> All, >> >> Do we have anything like release notes for this build? For testing >>purposes, it would be nice to have a list of things to specifically test >>for. >> >> Miriam >> _______________________________________________ >> Release-team mailing list >> Release-team(a)lists.kbase.us >> https://lists.kbase.us/mailman/listinfo/release-team >

1 0

Re: [Release-team] release notes
by Nomi Harris 22 Apr '13

22 Apr '13

Yes--I didn't get a chance to discuss this during today's meeting but I would like to see release notes for the services that are included in this minor release. This would be useful both internally (for testing, as Miriam notes) and externally (so users know what has changed). Nomi On Apr 22, 2013, at 12:47 PM, "Land, Miriam L." <landml(a)ornl.gov> wrote: > All, > > Do we have anything like release notes for this build? For testing purposes, it would be nice to have a list of things to specifically test for. > > Miriam > _______________________________________________ > Release-team mailing list > Release-team(a)lists.kbase.us > https://lists.kbase.us/mailman/listinfo/release-team

1 0

Re: [Release-team] of special interest to test
by Land, Miriam L. 22 Apr '13

22 Apr '13

Are they all called by 'make test'? Miriam On 4/22/13 12:34 PM, "Thomas Brettin" <brettin(a)mcs.anl.gov> wrote: >Hi Miriam, > >Here is the list of files that I modified in the genome_annotation module >this morning. They should be tested more rigorously than just ensuring >that the script returns 0. > >Chris, I'm including you because these are related to your bootcamps. The >change could be in production by the end of this week. > >Tom > ># modified: recompile_typespec ># modified: scripts/annotate_genome.pl ># modified: scripts/assign_functions_to_CDSs.pl ># modified: scripts/call_CDSs.pl ># modified: scripts/call_CDSs_by_glimmer.pl ># modified: scripts/call_CDSs_by_projection.pl ># modified: scripts/call_RNAs.pl ># modified: scripts/call_pyrrolysoproteins.pl ># modified: scripts/call_selenoproteins.pl ># modified: scripts/cs_to_genome.pl ># modified: scripts/fasta_to_genome.pl ># modified: scripts/genomeTO_strep_pneumo_repeats.pl ># modified: scripts/genomeTO_strep_suis_repeats.pl ># modified: scripts/genomeTO_to_coding_regions.pl ># modified: scripts/genomeTO_to_feature_data.pl ># modified: scripts/genomeTO_to_reconstructionTO.pl ># modified: scripts/merge_features.pl ># modified: scripts/reconstructionTO_to_roles.pl ># modified: scripts/reconstructionTO_to_subsystems.pl

1 0