github.com/containerd/nerdctl@v1.7.7/hack/generate-release-note.sh (about)

     1  #!/bin/bash
     2  
     3  #   Copyright The containerd Authors.
     4  
     5  #   Licensed under the Apache License, Version 2.0 (the "License");
     6  #   you may not use this file except in compliance with the License.
     7  #   You may obtain a copy of the License at
     8  
     9  #       http://www.apache.org/licenses/LICENSE-2.0
    10  
    11  #   Unless required by applicable law or agreed to in writing, software
    12  #   distributed under the License is distributed on an "AS IS" BASIS,
    13  #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14  #   See the License for the specific language governing permissions and
    15  #   limitations under the License.
    16  
    17  minimal_amd64tgz="$(find _output -name '*linux-amd64.tar.gz*' -and ! -name '*full*')"
    18  full_amd64tgz="$(find _output -name '*linux-amd64.tar.gz*' -and -name '*full*')"
    19  
    20  minimal_amd64tgz_basename="$(basename ${minimal_amd64tgz})"
    21  full_amd64tgz_basename="$(basename ${full_amd64tgz})"
    22  
    23  cat <<-EOX
    24  ## Changes
    25  (To be documented)
    26  
    27  ## Compatible containerd versions
    28  This release of nerdctl is expected to be used with containerd v1.6 or v1.7.
    29  
    30  ## About the binaries
    31  - Minimal (\`${minimal_amd64tgz_basename}\`): nerdctl only
    32  - Full (\`${full_amd64tgz_basename}\`):    Includes dependencies such as containerd, runc, and CNI
    33  
    34  ### Minimal
    35  Extract the archive to a path like \`/usr/local/bin\` or \`~/bin\` .
    36  <details><summary>tar Cxzvvf /usr/local/bin ${minimal_amd64tgz_basename}</summary>
    37  <p>
    38  
    39  \`\`\`
    40  $(tar tzvf ${minimal_amd64tgz})
    41  \`\`\`
    42  </p>
    43  </details>
    44  
    45  ### Full
    46  Extract the archive to a path like \`/usr/local\` or \`~/.local\` .
    47  
    48  <details><summary>tar Cxzvvf /usr/local ${full_amd64tgz_basename}</summary>
    49  <p>
    50  
    51  \`\`\`
    52  $(tar tzvf ${full_amd64tgz})
    53  \`\`\`
    54  </p>
    55  </details>
    56  
    57  <details><summary>Included components</summary>
    58  <p>
    59  
    60  See \`share/doc/nerdctl-full/README.md\`:
    61  \`\`\`markdown
    62  $(tar xOzf ${full_amd64tgz} share/doc/nerdctl-full/README.md)
    63  \`\`\`
    64  </p>
    65  </details>
    66  
    67  ## Quick start
    68  ### Rootful
    69  \`\`\`console
    70  $ sudo systemctl enable --now containerd
    71  $ sudo nerdctl run -d --name nginx -p 80:80 nginx:alpine
    72  \`\`\`
    73  
    74  ### Rootless
    75  \`\`\`console
    76  $ containerd-rootless-setuptool.sh install
    77  $ nerdctl run -d --name nginx -p 8080:80 nginx:alpine
    78  \`\`\`
    79  
    80  Enabling cgroup v2 is highly recommended for rootless mode, see https://rootlesscontaine.rs/getting-started/common/cgroup2/ .
    81  EOX