Outdated instructions for releasing an assembly

From Genecats
Jump to navigationJump to search

Pre-staging of assembly on hgwbeta

Put your name as the reviewer in main pushQ, and claim the Redmine ticket

That way people know you're working on it.

Check if chromosome sizes have changed significantly (batches*)

  • If you are releasing an update to an assembly, check to see if chromosome sizes have changed significantly. Report any significant changes to the developer.
  • Output chromosome sizes from the old and new assemblies into two files and compare them
hgwdev > hgsql -Ne "select chrom, size from chromInfo" $oldDb > oldChromSizes 
hgwdev > hgsql -Ne "select chrom, size from chromInfo" $newDb > newChromSizes 
hgwdev > sdiff -s oldChromSizes newChromSizes

* Steps marked with (batches) should be done for all assemblies in the pushQ at once. Make a note in the redmine issues of the other assemblies that you're working on the pre-staging and staging steps and then make another note once you're finished. This will hopefully speed up the release of the many assemblies on the horizon.

Check that any chain/net/liftOvers listed in the pushQ are to valid assemblies on the RR (batches)

If your assembly has a chain/net/liftOver to/from an assembly that is *not* on the RR (and not in the pushQ as another new assembly), you do not need to QA them or push them to the RR. Drop the relevant row(s) from your sub-pushQ by going to the track entry, clicking lock and then clicking the delete button. (If it would be helpful to see all of the other-organism liftover files at once, cd to /gbdb on hgwdev and use this command: ls -d */liftOver/*$db* .)

Check to ensure that there are enough tracks to be considered at least a "minimal" browser (batches)

For browser for a new organism (not an update to an existing browser), at least these tracks must exist:

  • sequence
  • repeat masker
  • gold/gap assembly tracks
  • genbank RNA & EST (xenoRNA if native RefSeq is sparse)
  • BLAT/PCR servers
  • CPG Islands
  • Genscan

And here's a list of tracks for a "pretty good" browser (these are strongly recommended if it's going to be part of a multiple alignment):

  • all of the "minimal" tracks listed above
  • Transmap (mapping gene set from closest well-annotated organism)
  • ENSEMBL Genes (if available)
  • Human Proteins
  • Human chain/net (at least human, if not others)
  • 3-8-way multiple alignment
  • Self Chain track for "finished" assemblies (e.g. human, mouse, zebrafish)

Stage assembly on hgwbeta

Push tables to mysqlbeta

Push the database and tables from hgwdev to hgwbeta

hgwdev> sudo mypush $db '*' mysqlbeta
  • Remove the hgFindSpec*, trackDb*, tableDescriptions and tableList tables from hgwbeta:
hgwbeta> hgsql $db

Then for each table listed above:
mysql> drop table $tablename;

Note: there may be several hgFindSpec and trackDb tables shows as trackDB_someonesname. So the * after those two tables just means delete all tables that begin with that name.

Alternative method to get db and tables on beta: create database on hgwbeta and push tables for $db

  • Create the database on hgwbeta.
hgwbeta > hgsql 
mysql > CREATE DATABASE $db;
  • Create a list of tables to import from hgwdev from the tables listed in the push queue. There should be a table called '$db' in the qapushq database on hgwbeta which can be used to get all of the tables at once:
hgwbeta > hgsql -Ne "SELECT tbls FROM $db WHERE dbs='$db'" qapushq > tables

To convert spaces to newlines for the tableList: 

awk '{ for (i=1;i<=NF;i++) print $i }' tables > tableList
  • Remove the hgFindSpec*, trackDb*, and tableDescriptions tables from the tableList.
  • Push the tables to hgwbeta.
hgwdev > bigPush.csh $db tableList

bigPush.csh gives size of the push at the end, which you can use to confirm it is "similar" to the original size from hgwdev. You can also compare sizes in the main pushQ by putting a "*" in the tables field, selecting hgwdev from the "Current Location", and then clicking on "show sizes" button.

Push chain/net tables in other organisms

In the sub-pushQ for the assembly there may be chain/net tracks listed. Push these tracks to hgwbeta. Only push tables for databases that exist on hgwbeta/RR though.

The tables to push for each listed assembly are:

  • chain$db
  • chain$dbLink
  • net$db

Since you may be pushing the same tables for several DBs (i.e., assemblies), it may save time to create a file containing the table names and use bigPush.csh: 

hgwdev > bigPush.csh $db tableList

After pushing the tables you will need to make beta in trackDb on hgwbeta for each of the other organisms.

Update hgcentralbeta

NOTE: the instructions below have you create several files containing metadata. It's nice to SAVE these files to use when staging the assembly on the RR.

dbDb

Here you will create (or update) hgcentralbeta.dbDb metadata. This will add the new assembly to the hgGateway page. When checking on hgwdev, make sure that the assembly date is correct under the description column. It should be later than the previous assembly. If it is not, contact the developer.

  • Check to make sure your row doesn't already exist in hgcentralbeta:
hgwbeta > hgsql hgcentralbeta
mysql > select * from dbDb where name = '$db'\G
  • Check to make sure the row exists on hgcentraltest:
hgwdev > hgsql hgcentraltest
mysql > select * from dbDb where name = '$db'\G
  • If the above looks correct, then redirect it to a file:
hgwdev > hgsql -N -e "select * from dbDb where name = '$db'" hgcentraltest > hgcentraltest.dbDb
  • Check the newly created file:
hgwdev > cat hgcentraltest.dbDb
  • Load onto hgcentralbeta:
hgwbeta > hgsql -h mysqlbeta -e "LOAD DATA LOCAL INFILE 'hgcentraltest.dbDb' INTO TABLE dbDb" hgcentralbeta
  • Check to see if hgcentralbeta has been updated with the new row:
hgwbeta > hgsql -h mysqlbeta -e "select * from dbDb where name = '$db'" hgcentralbeta

blatServers

The developer has often already requested that the blat servers be set up for the new assembly - check whether there are lines in hgcentraltest.blatServers. If they are there, follow the steps below. If not, request a blat server from the cluster-admins and create 2 lines in hgcentraltest.blatServers and hgcentralbeta.blatServers. The cluster-admins will give you the name of the blatServer and the port numbers for the isTrans and canPcr. Then you can add two new lines to the blatServer table for this information on both the hgcentraltest database on hgwdev. If this is an update to a previous assembly, you will want to leave the entries for the previous assemblies in the blatServers table. For more information about where the blat servers for different machines should be hosted go to Updating blat servers.

  • Get the data from hgwdev:
hgwdev > hgsql -Ne "SELECT * FROM blatServers WHERE db = '$db'" hgcentraltest > blat.dev
  • Check if the lines are already on beta and load if not:
hgwbeta > hgsql -h mysqlbeta -Ne "SELECT * FROM blatServers WHERE db = '$db'" hgcentralbeta 
hgwbeta > hgsql -h mysqlbeta -e "LOAD DATA LOCAL INFILE 'blat.dev' INTO TABLE blatServers" hgcentralbeta

genomeClade and gdbPdb

Move data for these tables, as needed, using same methods as listed above for dbDb:

  • hgcentralbeta.gdbPdb - gdbPdb is only relevant for human, mouse and rat assemblies, and is used with knownGene tracks.
  • hgcentralbeta.genomeClade - genomeClade is used to populate the pulldown menu on hgGateway, and set the order in which assemblies are listed. If this is not the first assembly for an organism, genomeClade will not need updating.

liftOverChain

Only copy lines from liftOverChain on hgcentraltest to hgcentralbeta if there are liftOver files listed in the pushQ and if the assemblies they go to/from exist on the RR. Check for lines in liftOverChain that should be in the pushQ but aren't (e.g. the liftOver from a previous assembly). Email the developer and ask them to add them to the pushQ if necessary. 

hgsql -Ne "SELECT * FROM liftOverChain WHERE fromDb = '$db' OR toDb = '$db'" hgcentraltest > chain.dev

Check beta, load if not present and recheck: 

hgsql -h mysqlbeta -Ne "SELECT * FROM liftOverChain WHERE fromDb = '$db' OR toDb = '$db'" hgcentralbeta 
hgsql -h mysqlbeta -e "LOAD DATA LOCAL INFILE 'chain.dev' INTO TABLE liftOverChain" hgcentralbeta

defaultDb

Do not change the value for defaultDb for human or mouse on hgwbeta. Leave them set to the previous assembly because many people use these assemblies and will be confused if it changes on hgwdev and hgwbeta.

For existing organisms other than human and mouse, change the defaultDb so that you don't accidentally test the previous assembly. 

mysql> UPDATE defaultDb SET name="$db" where genome="$genome";

$db will be the database of your working assembly (eg. panTro4, hg19, etc), and $genome will be the organism (eg. Chimp, Human, S. cerevisiae, etc).


If this is the first assembly for an organism, you will need the defaultDb entry in order for the assembly to appear on hgwbeta. Either transfer the line from hgcentraltest or add the line manually (probably easier) to defaultDb on hgcentralbeta: 

mysql> INSERT INTO defaultDb VALUES ("$genome", "$db");

Where $genome is the name of the organism (e.g., Human, Mouse, Chicken, etc.) and $db is the assembly (e.g., hg19, mm9, galGal3, etc.).

Check Meta Data

After you have completed the steps above, use the script checkMetaData.csh to make sure that all of the metadata is the same on hgwdev and on hgwbeta. Run this script in a temporary folder because it creates several files.

Push /gbdb/$db and html/description.html

Extract all of the gbdb files from the pushQ for your org and those for the other orgs as well: 

hgwbeta > hgsql -Ne "SELECT files FROM $db" qapushq > fileList

Ask for a push of the list of /gbdb files above from hgwdev to hgnfs1 (don't worry about the downloads yet). Remind the pushers that items that are symlinked on hgwdev should become real files on hgnfs1. To see how big these files are: 

hgwdev > cd /gbdb/$db
hgwdev > du -hscL `ls -d */liftOver/*$db*` .

Push image file to hgwbeta and rr

The image file that appears on the gateway page should reside in the kent source tree in: 

~/kent/src/hg/htdocs/images/

and a copy should exist at: 

hgwdev > /usr/local/apache/htdocs/images/


Confirm that the width of the box around the image in description.html is 15 pixels wider than the image.

Confirm that the gateway text is ok.

If there is a previous assembly, it is possible that it is using the same image on the gateway page. Check on hgwbeta to see if the image is missing. If it isn't, you don't need to ask for the image to be pushed.

To get the image to appear on hgwbeta and the RR, ask for a push of the file from hgwdev (at the /usr/local/apache... location) to hgwbeta and the RR. It's a good idea to ask for the push of the image to the RR during the staging process, as you will inevitably forget to push it when it's time to release the assembly. If there are any other images for this assembly (for instance, the phylo image that goes with the Conservation track), you can push them too.

Make trackDb on hgwbeta

Remake the trackDb on hgwbeta. Will likely need to be done again as track descriptions are updated. 

hgwbeta> cd kent/src/hg/makeDb/trackDb 
hgwbeta> make beta DBS=$db

Turn on GenBank updates

The new assembly should already be listed in the files align.dbs and hgwdev.dbs in the source tree at ~/kent/src/hg/makeDb/genbank/etc/. If it is not, check with Brian Raney. If it is, turn on GenBank updates on hgwbeta before 4:30 p.m., when the daily updates start, by adding the new assembly to /kent/src/hg/makeDb/genbank/etc/hgwbeta.dbs in alphabetical order. After committing the change: 

ssh hgwbeta
cd ~/kent/src/hg/makeDb/genbank/ 
git pull 
make etc-update-rr etc-update-server

Note: etc-update-rr is correct, as this updates all of the /genbank/etc files viewable by the rr. To see whether updates have run (at least a day after the *.dbs files were updated), check the update times of the table 'gbLoaded': 

hgwdev > updateTimes.csh $db gbLoaded

The update times will be out of sync between machines, but not by more than 24 hours or so if updates are running. The gbLoaded table will be updated regardless of whether changes to other GenBank tables were picked up. More genbank update instructions are available at Genbank updates.

The etc-update-server part of the make will cause the downloads mentioned below in the "Verify downloads" section to be created.

Review the phylogenetic location in pull-down menus on hgGateway (batches*)

Organisms are supposed to be listed in phylogenetic order in the pull-down menus on hgGateway. Check to see if your new genome is in the the right place evolutionarily. To determine what its position should be, use the "master tree," which is always the highest numbered file, located here: hgwdev:~/kent/src/hg/utils/phyloTrees. This tree is created by Hiram and reviewed by Bob. 

hgwbeta > hgsql hgcentralbeta 
mysql > select name, orderKey from dbDb order by orderKey;

* If there are multiple assemblies in the pushQ, go ahead and do this for all assemblies that are there. Then clearly mark in their redmine ticket that you already did this step so others know not to redo it. You many want to update the other tickets even before you start so that anyone else getting to this step knows you are already working on it.

Test on hgwbeta

Check the .2bit files

Check that it is not symlink on hgnfs1, that there is only one file, and is not in a subdirectory

The .2bit file (which contains the new assembly sequence in a compact, binary format) should exist at: /gbdb/$db/$db.2bit. It should be a symlink on hgwdev, but not on hgnfs1.

Check that all 3 copies of the .2bit file (gbdb, downloads, blat servers) are identical

The 3 locations of the .2bit file are:

  • /gbdb/$db/
  • /usr/local/apache/htdocs-hgdownload/goldenPath/$db/bigZips/ (on hgwdev)
  • /scratch/$db (on the BLAT server)

Use md5sum to confirm they are identical. Get the blat server from the hgcentral database and ssh into the machine: 

hgwdev > ssh qateam@blat#.cse.ucsc.edu

This will let you on to the blat machine after which you can look in /scratch/$db to see the .2bit file. If it is not the same as the other .2bit files ask the pushers to restart the assembly and to pull the newest .2bit file from /gbdb.

joinerCheck

Check that common keys between tables are in sync

hgwbeta > cd ~/kent/src/hg/makeDb/schema 
hgwbeta > joinerCheck -database=$db -keys all.joiner

Check that all tables in this database are mentioned in all.joiner

hgwbeta > cd ~/kent/src/hg/makeDb/schema 
hgwbeta > joinerCheck -database=$db -tableCoverage all.joiner

If not all of the tables are listed, email the developer asking him to add those tables to the tablesIgnored $db. According to Hiram it is probably ok for us to edit all.joiner ourselves.

Verify makedoc for all the tracks listed in the pushQ

The makedoc file should be here: /src/hg/makeDb/doc/$db.txt. Check that all the tracks listed in the pushQ are included.

Tables that probably won't be in the makedoc explicitly because they (usually because they are automatically generated with the initial assembly) are:

  • assembly
  • chromInfo
  • gc5BaseBw
  • grp
  • hgFindSpec
  • history
  • nestedRepeats
  • rmsk
  • simpleRepeat
  • tableDescriptions
  • genbank tables (xenoRefGene, etc)
  • supporting tables


If everything is there, be sure to click on “Y” in pushQ for both the main pushQ and all the tracks in the sub-pushQ. Note that you can quickly change the values for all the tracks in the sub-pushQ by accessing the database (qapushq) directly from mysqlbeta: 

mysql> UPDATE $db SET makeDocYN="Y";

Run featureBits to verify that the gold and gap tables together cover the entire genome

Run: 

 featureBits -countGaps -or $db gold gap

to make sure that the gold and gap table together cover the entire genome (should be 100%).

Check to make sure that none of the table names have underscores(_)

There are some older tables that have underscores (all_est and all_mrna) -- these are OK. What is definitely *not* OK is for split tables (tables that start with chr) to have more than one underscore in their name. Run the two queries below and verify that the only returned results follow these rules: 

mysql > show tables like "%\_%";
mysql > show tables like "%\_%\_%";

Make sure that there is a liftOver file from the previous assembly to this assembly

This is the number one request after a new release. These files are located here: 

/gbdb/[from database]/liftOver/[from database]To[to database].over.chain.gz

Verify blastTabs are updated if needed

If the new assembly is an update to the human, mouse, rat, zebrafish, D. melanogaster, C. elegans, or S. cerevisiae genomes, make sure that the appropriate blastTab tables to this assembly are built. More information about blastTabs can be found here.

Review all tracks in the sub-pushQ

Make sure to run doGenbankTests to check genbank tracks in the pushQ. If there are Ensembl Genes also run qaEnsGenes.csh.

At this point you can also do the chain/nets (if any) from other assemblies to this one, or you can elect to do them after the assembly is released.

Check that all of the MySQL tables are in good repair

To do this run: 

hgwbeta > sudo dbCheck.sh $db

This will do a myisamchk on all tables in that $db and repair any that need repairing (noted in the output by the words "REPAIR needed").

Check link to NCBIs Assembly database on hgGateway page

As of January 2012, NCBI has a new database for Assemblies. From this point forward, we should start linking to that database from the gateway page (our assembly description.html page). Please make sure that there is a link to the exact assembly.version that was used to make this browser. http://www.ncbi.nlm.nih.gov/genome/assembly/organism/

Check default position and default tracks are scientifically interesting and aesthetically pleasing

From the gateway page, press 'Click here to reset'. Go back to your assembly, then press 'submit'. You will be taken to the default position for your assembly. Make sure that the resulting area is scientifically interesting and aesthetically pleasing! You can edit the default location here: hgcentralbeta.dbDb.defaultPos and the default tracks here: /kent/src/hg/makeDb/trackDb/$db/trackDb.ra.

Check Blat and PCR

Check that you can do DNA and protein blat as well as PCR on the assembly

Verify downloads

The downloads are located at: 

hgwdev > /usr/local/apache/htdocs-hgdownload/goldenPath/$db/

Note that you should only push the downloads needed for the tracks in your pushQ. LiftOver files and vs* directories are for the chain/net tracks; and the multiz*way, phastCons*way and phyloP*way directories are for conservation tracks.

Note that $db/database will be empty except for README.txt. This directory will contain a dump of the database on the RR, but will always remain empty on hgwdev.

Note one more thing. These files: 

est.fa.gz      mrna.fa.gz      refMrna.fa.gz      xenoMrna.fa.gz
est.fa.gz.md5  mrna.fa.gz.md5  refMrna.fa.gz.md5  xenoMrna.fa.gz.md5

will not be present on hgwdev. They are generated automatically and rsync'ed to hgdownload after an assembly is added to hgwbeta.dbs and "make etc-update-server" is run in the kent/src/hg/makeDb/genbank/ directory on hgwbeta.

Check that the permissions are group 'genecats' writable (permissions should be at least 664)

The developer who created this assembly will probably be the owner of the directory and the files in it; you may need to ask him/her to change the permissions.

Check the md5sum

Check the md5sum against the md5sum.txt file for each directory you are planning to push. Note that the md5sum.txt in the liftOver directory may need to be edited (at least temporarily) to include only the liftOver files contained in the pushQ.

An easy way to compare the md5sum with md5sum.txt is to do a diff. This can be easily automated by running the following command in each directory: 

hgwdev > md5sum * | sort > ~/[filename]; diff md5sum.txt ~/[filename]

The sort is done with the assumption that the md5sum.txt file is sorted (it typically is). If the md5sum.txt file is not sorted, the sort is unnecessary. The temp file is created in your home directory to avoid creating temp files in htdocs-hgdownload. Note that the md5sum.txt file obviously does not contain md5sum.txt and it was created before there was a README.txt file, so your diff will show md5sum.txt and README.txt in the results. If everything is ok, those should be the only results. In the vs* directories, the XXXX.net.axt.gz file will show up as axtNet/XXXX.net.axt.gz. This is ok as long as the md5sums match.

Read and verify READMEs

Check that we have READMEs at top level, and for bigZips, chromosomes, liftOvers and comparatives (multiz, phastCons, vsXXX). Verify that the information in the READMEs is correct. Note that some of the files mentioned in the README are generated by the Genbank process, so they won't be present yet.

The genbank process will build the upstream* files on hgdownload if they don't exist, or are more than seven days old, with whatever genePred table is defined in etc/genbank.conf (e.g. hg16.upstreamGeneTbl = refGene ). Make sure that the README for the upstream* files reflects the genePred table listed for this assembly.

Stage assembly on Round Robin

Figure out if either you or Donna is going to edit the static docs

Email Donna and let her know that you're going to be releasing the assembly soon. Sometimes Donna does the docs and sometimes the QA person in charge of the assembly will do them. If you are going to edit them, see the static content for new assemblies page.

Make sure no tables need to be repushed from hgwdev to hgwbeta

You can use hgwdev > updateTimesDb.csh to compare table update times between hgwdev and hgwbeta. Everything but hgFindSpec, history, tableDescriptions, trackDb and the genbank tables should have the same update times. To see all of the tables in the assembly that are related to genbank do this: 

hgwdev > hgsql -Ne 'show tables' $db | egrep -f /cluster/data/genbank/etc/genbank.tbls

Double-check /gbdb files

Double-check that hgnfs1 (which is /gbdb on hgwbeta) has the files listed in the push queue. Remove any unnecessary files. If any files were updated on hgwdev in the course of QAing tracks, make sure the correct version is on hgnfs1.

Request rsync of entire database from push-request

Request an rsync of the entire database from mysqlbeta to mysqlrr. After the push is complete, ask for a drop of trackDb_public and hgFindSpec_public from mysqlrr, and then for a push of trackDb and friends. This will get the correct trackDb and trix files to the RR, after which tracks should appear and Track Search should work.

Note that if at any point you need to re-push some genbank tables, you must push ALL genbank tables together.

Mark main pushQ entry as "push requested"

Turn on genbank updates on the RR

Follow the same instructions here except edit rr.dbs instead

Request dump and autodump of database

Ask the pushers to dump the mysql tables from the RR to .txt.gz and .sql files on hgdownload:/usr/local/apache/htdocs/goldenPath/$db/database, and to start the weekly autodump for this database.

Adjust the release log in main pushQ

Compile a list of the tracks being released on this assembly and paste it into the release log box of the main pushQ entry for the initial release of the assembly. You can fetch the list from the assembly pushQ, but note that for the genbank tracks you will need to get the names manually. Alternatively, copy and paste the shortLabels of tracks from hgTracks. Look at previous release log entries for formatting.

Ensure the active column is set to 0 in the lines you are going to load into hgcentral.dbDb

The active column dictates whether the assembly appears in the drop-down menu on the gateway page. When it equals 0, it doesn't show in the pull down, when it equals 1, it does show. Change this to be 0 so that you can test the assembly on the RR without it being directly available to the public.

Update hgcentral

Note that the new assembly will start appearing in drop-downs as soon as hgcentral is updated, so be ready to test things (such as BLAT and PCR) soon after this step. Do NOT set active=1 in dbDb just yet.

Use the files you created to transfer the appropriate lines from hgcentraltest to hgcentralbeta, to also transfer those lines to the hgcentral database on the RR following the rules below. This is preferred, since we have verified that the lines are indeed correct since they worked on hgcentralbeta.

You'll transfer the lines for tables:

  • dbDb
  • blatServers
  • genomeClade
  • gdbPdb (if needed)
  • liftOverChain (if needed)

Do NOT update defaultDb yet, as the assembly is not active.

You can log into hgcentral on the RR like so: 

hgwdev > hgsql -h genome-centdb hgcentral

See Updating hgcentralbeta to see how to load the files into hgcentral.

It is only necessary to edit genomeClade if this is the first assembly for this species or if the order of species was changed. It is only necessary to update gdbPdb for assemblies that are being released with knownGenes. Also, note that it is ok for hgNearOk in dbDb to equal 1 for an older assembly of same organism.

Update the liftOver table so that it has all the liftOvers FROM this assembly to other assemblies. You will add the other liftOver lines when you have finished pushing the chain/nets for the other organisms.

Test the assembly tracks plus BLAT, PCR, liftOver on the RR

It is possible to test the tracks on the new assembly with active=0 by forcing db=$db in the hgTracks URL. First view an older assembly, then edit the URL so that you are actually viewing your new assembly.

Enable Assembly on RR and post-release follow-up

Set active=1 in hgcentral

When everything is working as expected, set the assembly to active: 

hgwdev > hgsql -h genome-centdb hgcentral
mysql > UPDATE dbDb SET active = 1 WHERE name = "$db";

Note that this means that everyone can now see the assembly on the RR.

Update defaultDb in hgcentral

Set your assembly as the default assembly for this organism. If this was a human or mouse assembly, go back and update hgcentraltest and hgcentralbeta too.

Verify again that everything is working as expected on the RR

Look briefly at the tracks, default position, gateway page, etc.

Push Downloads from hgwdev to hgdownload

These files are pushed directly from hgwdev: /usr/local/apache/htdocs-hgdownload/goldenPath/$db/ to hgdownload: /usr/local/apache/htdocs/goldenPath/$db/. Be sure to specify this in your push request. Ask the pushers to be sure to keep the permissions group 'genecats' writable. Make sure to only push the directories that are applicable to the tracks that are in the pushQ. After they are pushed, check that everything is there.

Update or add symlink in /usr/local/apache/htdocs-hgdownload/goldenPath/currentGenomes

Update or add a symlink to hgwdev > /usr/local/apache/htdocs-hgdownload/goldenPath/currentGenomes so that it points to the most recent assembly. In the currentGenomes directory: 

 rm Name_of_symlink
 ln -s ../$db Name_of_symlink

Request a push of the symlink from hgwdev to hgdownload. This is for ftp users who only want to go to the most recent assembly for an organism. After it is pushed, check that it is functioning correctly on the current genomes ftp page.

Ask push-request to make this assembly available on genome-mysql

Notify cluster-admin that the new assembly is available and needs to be released to genome-mysql. Permissions should be made for users "genome" and "genomep". The admins also need to update the mysql.db table permissions. (Jorge says we can ask them to follow the instructions in their wiki for "Mirror_Server".)

Push Static Content from hgwbeta and Round Robin

First make sure that either you or Donna have edited the pages below:

  • /usr/local/apache/htdocs/indexNews.html
  • /usr/local/apache/htdocs/goldenPath/newsarch.html
  • /usr/local/apache/htdocs/goldenPath/credits.html
  • /usr/local/apache/htdocs/FAQ/FAQreleases.html
  • /usr/local/apache/htdocs-hgdownload/downloads.html
  • /gbdb/$db/html/description.html

Then push them from hgwbeta to the RR and hgwbeta-public. For more information go to: Static_content_for_new_assemblies

Announce the Release on genome-announce@soe.ucsc.edu

Whoever edited the static docs should send announcements to: genome-announce mailing list (genome-announce@soe.ucsc.edu). It is best to take the section from the news page and edit it as needed for an email.

Update hgcentral.sql for mirrors

This will provide the most up-to-date version of hgcentral for mirrors. Ask the buildmeister to update the file at http://hgdownload.cse.ucsc.edu/admin/.

Optional: Some mirrors like to get hgcentral tables via ftp or rsync from ftp://hgdownload.cse.ucsc.edu/mysql/hgcentral/. You can request a push from hgnfs1 --> hgdownload if you want to make the hgcentral info available there immediately (otherwise it will be copied there by a weekly rsync).

You may need to update all.joiner for the RR

Relationships among tables are defined in all.joiner, which is updated on the RR when we push CGIs. If all.joiner was edited during QA of the tracks, you may want to ask for a push of all.joiner from hgwbeta (/usr/local/apache/cgi-bin/all.joiner) to the RR so that the table relationships show up in the table browser.

Chain/Nets/LiftOvers from other organisms

The timing of this step is not critical. It can be done anytime after the new assembly is active on the RR. These steps can be done in either order:

  • Push the nets and chains from other orgs to the new org (more information here)
  • Add the appropriate lines to the hgcentral.liftOverChain table (using hgsql -h genome-centdb) so that hgLiftOver and hgConvert works from other organisms to the new assembly. Test hgLiftOver and hgConvert. (Do not delete any old lines from liftOverChain . . . liftOver should still work for older assemblies.)

Next day follow-up

Check that Genbank is running on the RR

Make sure Genbank daily updates are running on Round Robin. You can do this by viewing the dates on the download files in htdocs/goldenPath/$db/bigZips/ (they should be more recent than the ones you pushed with your release). Also check that the table gbLoaded is getting updated on the RR with: 

 realTime.csh $db gbLoaded

Check the dump of the database in the downloads

Look in the database download directory and verify that the dump occurred.

Check that the downloads files generated by the genbank process are on hgdownload

Make sure that the files generated by genbank that are mentioned in the bigZips/README file, such as est.fa.gz, mrna.fa.gz, etc., and the upstream* files, are actually present on hgdownload.

Check that genome-mysql is working

From hgwdev: 

 mysql -h genome-mysql -A -u genome $db

Retire the assembly sub-pushQ

Make sure there are release log entries for the net and chain tracks in other databases. 

 hgwdev> retirePushQ.csh $db

(The script will remove release log notes for all push queue entries where dbs=$db.)


Press "done!" in the main push queue

This will update the release log.

Check the release log

The day after you press “done!” in the main push queue for your assembly, the Release Log on the website will be updated with the information about the new release (from whatever you entered into the Release Log field of the main push queue). Verify that this happened on the release log page. To edit an entry, find it in the Log section of the push queue and edit there. Changes will appear in the release log the next day.

Retrieved from "https://genomewiki.ucsc.edu/genecats/index.php?title=Outdated_instructions_for_releasing_an_assembly&oldid=1031"