-
Notifications
You must be signed in to change notification settings - Fork 80
Build Procedure
Ian Gilman edited this page Jun 8, 2022
·
30 revisions
- Make sure you have all three repositories (openseadragon, openseadragon.github.com, and site-build) cloned next to each other in the same folder.
- Check to see if there are any pull requests in the site-build repository waiting to be merged for the release. If so (and they're ready), merge them.
- Make sure they're all up to date, and that you're on their master branches.
- Do a test
grunt publishfrom the openseadragon repository and agrunt docin the site-build repository to make sure the JSDocs build. If you want, you can also do agrunt devin the site-build repository to check it visually. - In the openseadragon repository:
- Update the version number in package.json.
- Make sure the
changelog.txtfile lists all the relevant changes and remove the "in progress" indication from the top version. - Commit.
-
git tag -a v<version> -m <version>(note thev), for example:git tag -a v0.9.125 -m 0.9.125. - Double-check that you tagged the correct revision (you can use
gitk, the GitHub GUI, or straight git likegit show v<version>). -
git push origin master v<version>. -
grunt publishto build and publish to the site-build folder. - Create a new release at https://github.com/openseadragon/openseadragon/releases/new and upload the files in build/releases (name it the same as the tag, e.g.
v2.4.0). Enter the appropriate info from the changelog. - Publish the release to npm:
npm publish(see https://docs.npmjs.com/getting-started/publishing-npm-packages for more info). - Add the next version number along with "in progress" to
changelog.txt; commit and push.
- In the site-build repository:
- Commit the changes from the previous step.
-
git tag -a v<version> -m <version>(note thev) git push origin master v<version>- Run
grunt publishto build and publish to the openseadragon.github.com folder.
- In the openseadragon.github.com folder:
- Commit the changes and push to GitHub.
- Let Ian know, and he'll tweet about it from @openseadragon and mention it in Gitter and Discord.
- Update https://github.com/openseadragon/browser-extension to the latest version of OSD.
- https://github.com/openseadragon/svg-overlay, https://github.com/openseadragon/html-overlay, and https://github.com/openseadragon/bookmark-url automatically use the latest version, but check them and merge any of their pull requests that have been waiting for the new release.