tools/release_tool/README.md

   1 # Content
   2
   3 - git_release.sh
   4 - onert_version.sh
   5
   6 # git_release.sh
   7
   8 This tool helps you to automate GitHub releases.
   9
  10 ## Usage
  11 ```
  12 $ ./git_release.sh --tag TAG --release_note RELEASE_NOTE \
  13 --token TOKEN [--release_name RELEASE_NAME] [--commitish COMMITISH] [--draft] \
  14 [--host_name HOST_NAME] [--repo_owner REPO_OWNER] [--repo_name REPO_NAME] [--asset] ...
  15 ```
  16
  17 ## Options
  18 ```
  19 --tag              The name of the tag
  20 --release_name     The name of the release
  21 --release_note     Path of text file describing the contents of the release
  22 --commitish        The commitish value that determines where the Git tag is created from
  23 --draft            Create a draft release
  24 --token            User token for authentication
  25 --host_name        Host name for endpoint URL [Enterprise-specific endpoint only]
  26 --repo_owner       Owner of the repository
  27 --repo_name        The name of the repository
  28 --asset            Path of release asset
  29 ```
  30
  31 ## Examples
  32 ```
  33 $ ./git_release.sh --tag 1.9.0 --commitish release/1.9.0 --token 0de25f1ca5d1d758fe877b18c06 \
  34   --repo_owner mhs4670go --repo_name test_repo --release_note local/repo/release_note \
  35   --asset ONE-compiler.tar.gz --asset ONE-runtime.tar.gz"
  36
  37 $ ./git_release.sh --tag v1.1 --commitish c024e85d0ce6cb1ed2fbc66f1a9c1c2814da7575 \
  38   --token 0de25f1ca5d1d758fe877b18c06 --repo_owner Samsung --repo_name ONE \
  39   --release_name "Release Automation" --release_note /home/mhs4670go/ONE/release_doc \
  40   --host_name github.sec.company.net --draft
  41 ```
  42
  43 ## Reference
  44 https://developer.github.com/v3/repos/releases/#create-a-release
  45
  46
  47 # onert_version.sh
  48
  49 onert_version.sh updates version information.
  50
  51 ## Usage
  52 ```
  53 $ ./onert_version.sh -h
  54 Usage: onert_version.sh version
  55 Update or show onert version information
  56 ```
  57
  58 ## Options
  59 ```
  60 -h   show this help
  61 -s   set onert version
  62 ```
  63
  64 ## Examples
  65 ```
  66 $ ./onert_version.sh           => show current onert version
  67 $ ./onert_version.sh -s 1.6.0  => set onert version info in all sources
  68 ```