[UX] Add commit hash

[Michaelvll]

Make it possible to get commit hash of the current SkyPilot for both installed from pypi and source code.

Tested (run the relevant ones):

• Code formatting: bash format.sh
• Any manual or new tests for this PR (please specify below)
  • pip install -e .; cd ~; sky --commit; sky launch -c test --cpus 2+; sky spot launch -n test-aws --cpus 2 --cloud aws
  • pip install .; cd ~; sky --commit; sky launch -c test --cpus 2+ echo hi; sky down sky-spot-controller-xxx
  • Upload to test pypi with the building script in nightly build script, pip install -i https://test.pypi.org/simple/ skypilot==1.0.0.dev20231020; sky --commit
  • pip install -e .; sky launch -c test-commit --cpus 2 echo hi; ssh test-commit; sky -c
• All smoke tests: pytest tests/test_smoke.py
• Relevant individual smoke tests: pytest tests/test_smoke.py::test_fill_in_the_name
• Backward compatibility tests: bash tests/backward_comaptibility_tests.sh

[cblmemo]

Thanks for adding this! I'm a little confused about the default value {{SKYPILOT_COMMIT_SHA}}. Where is it replaced by the commit hash? I tried searching in the repository but did not find anything helpful..

[cblmemo]

Why add this? Seems like not relevant to this PR..?

[Michaelvll]

Previously, the pylint did not check this file as the file was not changed for a long time before, and it has wrong-import-position warning now.

[Michaelvll]

Thanks for adding this! I'm a little confused about the default value {{SKYPILOT_COMMIT_SHA}}. Where is it replaced by the commit hash? I tried searching in the repository but did not find anything helpful..

We did not do it in our code, but manually replace it for each release before this PR, and in our CI https://github.com/skypilot-org/skypilot/blob/d38b4b4163e4d5f4ef98895e30b4b5c04fd23dde/.github/workflows/pypi-nightly-build.yml

[cblmemo]

Thanks for the explanation! LGTM 🫡

[Michaelvll]

We fixed the logic for setup and __init__ to make sure __init__ reverts to original content, so that it can correctly handle python -m build. PTAL @cblmemo.

[cblmemo]

Thanks for the fix! Left several comments 😉