New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make it easier to execute commands in the release notes #62

Open
thewtex opened this Issue Sep 10, 2018 · 1 comment

Comments

Projects
None yet
2 participants
@thewtex
Member

thewtex commented Sep 10, 2018

In the release documentation, ITK/Documentation/Release.md make it easier to copy and execute commands.

  • Remove $ from shell commands
  • For long, multi-line commands, create short scripts inline, e.g.
cat << REMOTE_SCRIPT_EOF > /tmp/itk_linux_release.sh
set -ex

cd ~/Packaging/ITKPythonPackage
git reset --hard HEAD
git fetch origin
git checkout v$version
git clean -fdx
/home/kitware/Support/skbuild-venv/bin/python setup.py sdist --formats=gztar,zip
./scripts/dockcross-manylinux-build-wheels.sh
tar cvzf /tmp/dist-linux.tar.gz ./dist
rm dist/*
cd ..
./ITKPythonPackage/scripts/dockcross-manylinux-build-tarball.sh

REMOTE_SCRIPT_EOF

ssh $metroplex 'bash -s' < /tmp/itk_linux_release.sh

Suggested by @jcfr

See also the discussion here:

http://review.source.kitware.com/#/c/23699/

@jcfr

This comment has been minimized.

Show comment
Hide comment
@jcfr

jcfr Sep 10, 2018

Contributor

Similarly, set of commands could be listed as:

   $ git checkout release && \
     git reset --hard origin/release && \
     git merge --ff-only v$version && \
     git push origin release && \
     git checkout master

instead of

   $ git checkout release
   $ git reset --hard origin/release
   $ git merge --ff-only v$version
   $ git push origin release
   $ git checkout master

It allows to copy paste the whole block

Contributor

jcfr commented Sep 10, 2018

Similarly, set of commands could be listed as:

   $ git checkout release && \
     git reset --hard origin/release && \
     git merge --ff-only v$version && \
     git push origin release && \
     git checkout master

instead of

   $ git checkout release
   $ git reset --hard origin/release
   $ git merge --ff-only v$version
   $ git push origin release
   $ git checkout master

It allows to copy paste the whole block

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment