Creating a pushQ Entry: Difference between revisions

From Genecats
Jump to navigationJump to search
(added more details based on Max's "Pre-pushq checklist" wiki page)
No edit summary
Line 1: Line 1:
This page is for documenting the process of creating/updating a pushQ entry. For the entire hand-off of a Track from Developers to QAers, see the redmine wiki page [http://redmine.soe.ucsc.edu/projects/genomebrowser/wiki/Track here].
This page is for documenting the process of creating/updating a pushQ entry. For the entire hand-off of a Track from Developers to QAers, see the redmine wiki page [http://redmine.soe.ucsc.edu/projects/genomebrowser/wiki/Track here].


After you have finished creating a track and it is ready for QA, you should add an entry to the qapushq table on hgwbeta. There is a [http://hgwbeta.cse.ucsc.edu/cgi-bin/qaPushQ CGI] for this.
After you have finished creating a track and it is ready for QA, you should update the redmine status to "QA ready" and set the pushq fields in the redmine ticket.


'''Add a track to the pushQ only if everything is ready.'''   
'''Set a ticket to pushq-ready only if everything is ready.'''   
This includes:
This includes:


Line 17: Line 18:
* View the track in the browser, check for pile-ups on one whole chromosome.
* View the track in the browser, check for pile-ups on one whole chromosome.


'''Editing the pushQ entry:'''
'''Editing the pushQ fields'''
 
Engineers -- When you finish a track or assembly, and it's ready for QA do the following:
* Set status to QA Ready
* Complete Table List & File List
* Put any special instructions in redmine as an update to the ticket


''PRIORITY:''
QAers -- To see what's ready for QA check the query named "ready for QA": http://redmine.soe.ucsc.edu/projects/genomebrowser/issues?query_id=16
Leave this set to A.
* Claim redmine issue as usual
* Set status to Reviewing
* If you would like for it to have an entry on the Release Log page, complete the Release Log Text and Release Log URL
* When you finish QA and push to the RR: set status to Released and check the "released to RR" checkbox.


''IMPORTANCE:''
Helpful wiki pages:
Leave set to Unprioritized.
* redmine instead of the pushQ:
http://redmine.soe.ucsc.edu/projects/genomebrowser/wiki/PushQ
* process for Tracks in redmine (with no more pushQ):
http://redmine.soe.ucsc.edu/projects/genomebrowser/wiki/Track


''NEW TRACK?:''
''NEW TRACK?:''
Line 43: Line 55:
''TABLES:''
''TABLES:''
List all tables that should be pushed. Don't forget to include extFile and seq if your track uses them.
List all tables that should be pushed. Don't forget to include extFile and seq if your track uses them.
''CGIs:''
Leave this blank in favor of completing it in the corresponding redmine issue. If this track depends on CGI changes that are checked into a particular version, add that number to the "Target Version" number in redmine.


''FILES:''
''FILES:''
Line 54: Line 63:
''SIZE:''
''SIZE:''
Press the Show Sizes button.  All tables and files should be found without errors (if they are not, you probably have entered a path incorrectly or have a typo in the lists).  Scroll to the bottom of the page and click the "Set Size as ..." link.
Press the Show Sizes button.  All tables and files should be found without errors (if they are not, you probably have entered a path incorrectly or have a typo in the lists).  Scroll to the bottom of the page and click the "Set Size as ..." link.
''CURRENT LOCATION:''
Set to hgwdev.


''MAKEDOC VERIFIED:''
''MAKEDOC VERIFIED:''
Leave this set to N.
Leave this set to N.
''ONLINE HELP:''
This is generally an unused field.


''INDEX VERIFIED:''
''INDEX VERIFIED:''
Line 69: Line 72:
''ALL.JOINER VERIFIED:''
''ALL.JOINER VERIFIED:''
Leave this set to N.
Leave this set to N.
''STATUS:''
Leave blank.
''FEATUREBITS:''
Leave blank.
''SPONSOR (LOCAL):''
Enter your first name, or your username, in lower-case letters.  Whatever name you decide to use, be consistent among tracks.


''REVIEWER:''
''REVIEWER:''
Leave blank.
Leave blank.
''EXTERNAL SOURCE:''
Leave this blank in favor of completing it in the corresponding redmine issue.
''OPEN ISSUES:''
Generally leave blank.  Put any known issues with the track in the corresponding redmine issue.
''NOTES:''
Enter the number of the corresponding redmine issue.  Put notes to QAers in a note in the redmine issue.


[[Category:Browser QA]]
[[Category:Browser QA]]
[[Category:Browser QA dev handoff]]
[[Category:Browser QA dev handoff]]

Revision as of 17:54, 9 March 2017

This page is for documenting the process of creating/updating a pushQ entry. For the entire hand-off of a Track from Developers to QAers, see the redmine wiki page here.

After you have finished creating a track and it is ready for QA, you should update the redmine status to "QA ready" and set the pushq fields in the redmine ticket.

Set a ticket to pushq-ready only if everything is ready. This includes:

  • All tables have been built.
  • makedoc entry is complete and checked in.
  • TrackDb has been edited (including search stanzas). If this is an update to an existing track, you may need to use release tags.
  • Make alpha on hgwdev in src/hg/makeDb/trackDb directory.
  • All underlying files are complete and in the correct location (usually /gbdb/).
  • All associated downloads files have been created and are in the correct location (usually /usr/local/apache/htdocs-hgdownload/goldenPath/), and accompanying README.txt and md5sum.txt files are present.
  • html text for details page (a.k.a. Track Description page) is complete (see also description pages and citation formats) and is in highest logical level for the assembly. If this is an update to an existing track, you may need to make the updated details page visible on alpha while the original page is visible on beta and public. This can be achieved with release tags and an html qualifier in the alpha stanza.
  • All tables have been added to the makeDb/schema/all.joiner file.
  • Data contributor (if any) has approved of the track display.
  • View the track in the browser, check for pile-ups on one whole chromosome.

Editing the pushQ fields

Engineers -- When you finish a track or assembly, and it's ready for QA do the following:

  • Set status to QA Ready
  • Complete Table List & File List
  • Put any special instructions in redmine as an update to the ticket

QAers -- To see what's ready for QA check the query named "ready for QA": http://redmine.soe.ucsc.edu/projects/genomebrowser/issues?query_id=16

  • Claim redmine issue as usual
  • Set status to Reviewing
  • If you would like for it to have an entry on the Release Log page, complete the Release Log Text and Release Log URL
  • When you finish QA and push to the RR: set status to Released and check the "released to RR" checkbox.

Helpful wiki pages:

  • redmine instead of the pushQ:

http://redmine.soe.ucsc.edu/projects/genomebrowser/wiki/PushQ

  • process for Tracks in redmine (with no more pushQ):

http://redmine.soe.ucsc.edu/projects/genomebrowser/wiki/Track

NEW TRACK?: If this same track exists on this or another assembly, or this is an addition to an existing track, leave this set to N. If this is a brand new track set this to Y. If this isn't a track at all, set this to X.

TRACK: Put an identifier for the track here. This is often the shortLabel.

RELEASE LOG: Generally you should put the track shortLabel followed by comments in parentheses, if any (e.g. UCSC Genes (data update)). No need to enter the database name. This text will appear in the Release Log.

RELEASE LOG URL If you would like the Release Log entry for this track to link to the track description page, then enter a relative link to it here, e.g.:

../../cgi-bin/hgTrackUi?db=hg18&g=wgEncodeBuOrchid

DATABASES: List the database(s) where your table(s) are located (e.g. hg19, hgFixed).

TABLES: List all tables that should be pushed. Don't forget to include extFile and seq if your track uses them.

FILES: List all files that should be pushed. Don't forget to include:

  • gbdb files
  • download files

SIZE: Press the Show Sizes button. All tables and files should be found without errors (if they are not, you probably have entered a path incorrectly or have a typo in the lists). Scroll to the bottom of the page and click the "Set Size as ..." link.

MAKEDOC VERIFIED: Leave this set to N.

INDEX VERIFIED: Leave this set to N.

ALL.JOINER VERIFIED: Leave this set to N.

REVIEWER: Leave blank.