Skip to content

Commit

Permalink
[update docs] Allow set_package_versions to be used on the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cmdcolin committed Aug 16, 2018
1 parent 823c9aa commit 3e8396c
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 21 deletions.
8 changes: 6 additions & 2 deletions README.md
Expand Up @@ -88,12 +88,16 @@ NOTE: Beginning in 1.12.4,
1. Run `build/release.sh $newReleaseVersion $nextReleaseVersion-alpha.0`, check its work, and then run the `git push` command it suggests to you. This makes a tag in the repository for the release, named, e.g. `1.6.3-release`. This should cause Travis CI
to create a release on GitHub under https://github.com/GMOD/jbrowse/releases

1. Add release notes to the new GitHub release that Travis created. Can just paste these from release-notes.txt, which is in Markdown format.
1. Add release notes to the new GitHub release that Travis created. Can just paste these from release-notes.md, which is in Markdown format.

1. Write a blog post on jbrowse.org announcing the release, with links to the built releases on GitHub. The SHA1 sums of the built release files can be seen near the end of the Travis build log, and the HTML version of the release notes can be gotten by running `make -f build/Makefile release-notes.html`.
1. Edit a file in website/blog/ folder with the date and release name in the blog title. Include notes from release-notes.md and links to files that were generated in the release page. The SHA1 sums of the built release files can be seen near the end of the Travis build log, and the HTML version of the release notes can be gotten by running `make -f build/Makefile release-notes.html`.

1. Update the latest-release code checkout on the site, which the "Latest Release" demo on the jbrowse.org points to, to be an unzipped-and-set-up copy of the latest release.

1. Write a twitter post for usejbrowse and JBrowseGossip with the announcement link to the blogpost

1. Upload the release package to the website code directory, unzip and set the version as the latest

1. Write an email announcing the release, sending to gmod-ajax. If it is a major release, add gmod-announce and make a GMOD news item.

As you can tell, this process could really use some more streamlining and automation.
2 changes: 1 addition & 1 deletion build/release.sh
Expand Up @@ -44,7 +44,7 @@ mv release-notes.md.new release-notes.md
build/set_package_versions.pl $VERSION src/JBrowse/package.json package.json

# commit the release notes and package.jsons
git commit -m "release $VERSION" release-notes.md src/JBrowse/package.json package.json
git commit -m "release $VERSION" release-notes.md src/JBrowse/package.json package.json website/siteConfig.js

# make a tag and update master
git tag $VERSION-release
Expand Down
2 changes: 1 addition & 1 deletion build/set_package_versions.pl
Expand Up @@ -24,7 +24,7 @@

$text =~ s/"version"\s*:\s*"[^"]+"/"version": "$release"/
or die "failed to insert version info $filename";

open my $f, '>', $filename or die "$! writing $filename";
$f->print( $text );
}
14 changes: 3 additions & 11 deletions docs/site/installation.md
Expand Up @@ -37,17 +37,9 @@ On CentOS/RedHat
## Download JBrowse


Download a JBrowse release from GitHub. The main release is JBrowse-1.15.1.zip
Download a JBrowse release from GitHub


curl -O https://github.com/GMOD/jbrowse/releases/download/1.15.1-release/JBrowse-1.15.1.zip
unzip JBrowse-1.15.1.zip
sudo mv JBrowse-1.15.1 /var/www/html/jbrowse
cd /var/www/html
sudo chown `whoami` jbrowse
cd jbrowse
./setup.sh # don't do sudo ./setup.sh
{@inject: setup_snip}



**IMPORTANT NOTE: if you are using JBrowse plugins, you must download the source code e.g. https://github.com/GMOD/jbrowse/archive/1.15.1-release.tar.gz or use git clone of gmod/jbrowse instead of the minified release e.g. https://github.com/GMOD/jbrowse/releases/download/1.15.1-release/JBrowse-1.15.1.zip**
**IMPORTANT NOTE: if you are using JBrowse plugins, you must download the source code e.g. https://github.com/GMOD/jbrowse/archive/{@inject: version}-release.tar.gz or use git clone of https://github.com/GMOD/jbrowse instead of the minified release**
7 changes: 4 additions & 3 deletions docs/site/tutorial.md
Expand Up @@ -133,8 +133,9 @@ If you have troubles, send an email to gmod-ajax@lists.sourceforge.net or create

## Footnotes

a) If you want to customize JBrowse's javascript or use plugins, use JBrowse-1.15.1-dev.zip instead of JBrowse-1.15.1.zip (e.g. the -dev version). The -dev version will download extra javascript dependencies and can recompile JBrowse using webpack, but the non-dev version cannot.

b) If the folder was not called data, e.g. you had your files in /var/www/html/jbrowse/otherdata, then you can visit http://localhost/jbrowse/?data=otherdata (this automatically lends a way to have "multiple data directories" since you could navigate to different ?data= URL paths this way. the "dataset selector" configuration contains more details)
a) If the folder was not called data, e.g. you had your files in /var/www/html/jbrowse/otherdata, then you can visit http://localhost/jbrowse/?data=otherdata (this automatically lends a way to have "multiple data directories" since you could navigate to different ?data= URL paths this way. the "dataset selector" configuration contains more details)

c) The "configuration format" is called .conf, but JSON format is also allowed. See [configuration file formats](configuration_file_formats.md) guide for details.
b) The "configuration format" is called .conf, but JSON format is also allowed. See [configuration file formats](configuration_file_formats.md) guide for details.

c) If you are doing source code updates or using plugins, you must use a git clone or the "source code" release from GitHub pages. Also the "-dev" release from older versions is supplanted by using a git clone or "source code" release
3 changes: 2 additions & 1 deletion website/pages/en/index.js
Expand Up @@ -80,13 +80,14 @@ const HeaderInfo = props => (
class Index extends React.Component {
render() {
let language = this.props.language || '';
let version = siteConfig.version;

return (
<Container className="mainContainer documentContainer postContainer">
<div className="flexContainer" style={{display: 'flex'}}>
<div>
<HeaderInfo />
<iframe width="100%" height="600" src="https://jbrowse.org/code/JBrowse-1.15.1/?loc=ctgA%3A9892..32101&tracks=DNA%2CTranscript%2Cvolvox_microarray_bw_density%2Cvolvox_microarray_bw_xyplot%2Cvolvox-sorted-vcf%2Cvolvox-sorted_bam_coverage%2Cvolvox-sorted_bam&data=sample_data%2Fjson%2Fvolvox&tracklist=0"></iframe>
<iframe width="100%" height="600" src=`https://jbrowse.org/code/latest-release/?loc=ctgA%3A9892..32101&tracks=DNA%2CTranscript%2Cvolvox_microarray_bw_density%2Cvolvox_microarray_bw_xyplot%2Cvolvox-sorted-vcf%2Cvolvox-sorted_bam_coverage%2Cvolvox-sorted_bam&data=sample_data%2Fjson%2Fvolvox&tracklist=0`></iframe>
<div className="mainContainer">
<FeatureCallout />
<BrowserCompat />
Expand Down
13 changes: 11 additions & 2 deletions website/siteConfig.js
Expand Up @@ -27,7 +27,16 @@ const createVariableInjectionPlugin = variables => {
};

const siteVariables = {
version: '1.15.1',
"version": "1.15.1",
"setup_snip": [
` curl -O https://github.com/GMOD/jbrowse/releases/download/${version}-release/JBrowse-${version}.zip`,
` unzip JBrowse-${version}.zip`,
` sudo mv JBrowse-${version} /var/www/html/jbrowse`,
' cd /var/www/html',
' sudo chown `whoami` jbrowse',
' cd jbrowse',
' ./setup.sh # don\'t do sudo ./setup.sh'
].join('\n')
};


Expand Down Expand Up @@ -76,7 +85,7 @@ const siteConfig = {
onPageNav: 'separate',
scripts: ['https://buttons.github.io/buttons.js'],
blogSidebarCount: 'ALL',
latestVersion: '1.15.0'
latestVersion: siteVariables.version
};

module.exports = siteConfig;

0 comments on commit 3e8396c

Please sign in to comment.