Skip to content

Commit

Permalink
add readme for developers
Browse files Browse the repository at this point in the history
  • Loading branch information
pluskid committed Sep 7, 2016
1 parent f06d994 commit 6e2c1ae
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README-DEV.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Workflow for making a release

1. Update `NEWS.md` to list important changes
2. Check out the `stable` branch, rebase with `master`.
3. Update `libmxnet_curr_ver` in `deps/build.jl` to the latest commit SHA (or any proper reference). Using `master` here is not good because future changes in libmxnet might break existing Julia packages.
4. Run tests.
5. Commit changes and push.
6. Run `Pkg.tag("MXNet")` in Julia.
7. Run `Pkg.publish()`, which will open a browser for making a pull request to METADATA.jl.
8. Edit the [releases page](https://github.com/dmlc/MXNet.jl/releases) to copy the release notes from `NEWS.md` to the newly created release tag.
2 changes: 2 additions & 0 deletions deps/build.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ using Compat
# First try to detect and load existing libmxnet
################################################################################
libmxnet_detected = false
libmxnet_curr_ver = "master"

if haskey(ENV, "MXNET_HOME")
info("MXNET_HOME environment detected: $(ENV["MXNET_HOME"])")
Expand Down Expand Up @@ -58,6 +59,7 @@ if !libmxnet_detected
ChangeDirectory(_srcdir)
`rm -rf mxnet`
`git clone --recursive https://github.com/dmlc/mxnet`
`git checkout $libmxnet_curr_ver`
FileRule(joinpath(_libdir, "libmxnet.so"), @build_steps begin
ChangeDirectory("$_mxdir")
`cp make/config.mk config.mk`
Expand Down

0 comments on commit 6e2c1ae

Please sign in to comment.