Devlake release guide

Please make sure your public key was included in the https://downloads.apache.org/incubator/devlake/KEYS , if not, please update https://downloads.apache.org/incubator/devlake/KEYS first.

How to update KEYS

  1. Clone the svn repository
    svn co https://dist.apache.org/repos/dist/dev/incubator/devlake
  2. Append your public key to the KEYS file
    cd devlake
(gpg --list-sigs <your name> && gpg --armor --export <your name>) >> KEYS
  3. Upload
    svn add KEYS
svn commit -m "update KEYS"
svn cp https://dist.apache.org/repos/dist/dev/incubator/devlake/KEYS https://dist.apache.org/repos/dist/release/incubator/devlake/ -m "update KEYS"

We will use v0.12.0 as an example to demonstrate the release process.

ASF Release Policy

https://www.apache.org/legal/release-policy.html https://incubator.apache.org/guides/releasemanagement.html

Tools:

gpg creating and verifying the signature shasum creating and verifying the checksum git checkout and pack the codebase svn uploading the code to the Apache code hosting server

Prepare

  • Check against the Incubator Release Checklist
  • Create folder releases/lake-v0.12.0 and put the two files docker-compose.yml and env.example in there.
  • Update the file .github/ISSUE_TEMPLATE/bug-report.yml to include the version v0.12.0

Pack

  • Checkout to the branch/commit

    git clone https://github.com/apache/incubator-devlake.git
cd incubator-devlake
git checkout 25b718a5cc0c6a782c441965e3cbbce6877747d0

  • Tag the commit and push to origin

    git tag v0.12.0-rc2
git push origin v0.12.0-rc2

  • Pack the code

    git archive --format=tar.gz --output="<the-output-dir>/apache-devlake-0.12.0-incubating-src.tar.gz" --prefix="apache-devlake-0.12.0-incubating-src/" v0.12.0-rc2

  • Before proceeding to the next step, please make sure your public key was included in the https://downloads.apache.org/incubator/devlake/KEYS

  • Create signature and checksum

    cd <the-output-dir>
gpg -s --armor --output apache-devlake-0.12.0-incubating-src.tar.gz.asc --detach-sig apache-devlake-0.12.0-incubating-src.tar.gz
shasum -a 512  apache-devlake-0.12.0-incubating-src.tar.gz > apache-devlake-0.12.0-incubating-src.tar.gz.sha512

  • Verify signature and checksum

    gpg --verify apache-devlake-0.12.0-incubating-src.tar.gz.asc apache-devlake-0.12.0-incubating-src.tar.gz
shasum -a 512 --check apache-devlake-0.12.0-incubating-src.tar.gz.sha512

Upload

  • Clone the svn repository
    svn co https://dist.apache.org/repos/dist/dev/incubator/devlake
  • Copy the files into the svn local directory
    cd devlake
mkdir -p 0.12.0-incubating-rc2
cp <the-output-dir>/apache-devlake-0.12.0-incubating-src.tar.gz* 0.12.0-incubating-rc2/
- Upload local files
svn add 0.12.0-incubating-rc2
svn commit -m "add 0.12.0-incubating-rc2"

Vote

  1. Devlake community vote:

  2. Apache incubator community vote:

Release

Apache

GitHub