Get all the steps together for creating a release.

Closes #22
Closes #12

Author: brettcannon

.github/workflows/release.yml

@@ -2,15 +2,14 @@ name: Release
 
 on: workflow_dispatch
 
+permissions:
+  contents: write
+
 jobs:
   details:
     name: Release details
     runs-on: ubuntu-latest
 
-    # XXX
-    # permissions:
-    #   contents: write
-
     outputs:
       version: ${{ steps.version.outputs.release }}
       tag: ${{ steps.version.outputs.tag }}
@@ -48,26 +47,26 @@ jobs:
 
     steps:
       - name: Create release
-        # XXX run: gh release create XXX --notes "" --draft
-        run: echo ${{ needs.details.outputs.tag }}
+        # Specify release notes to make creation non-interactive.
+        run: gh release create ${{ needs.details.outputs.tag }} --notes "" --draft
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
 
   build:
     name: Build ${{ matrix.target }}
     needs: [details, release]
     runs-on: ${{ matrix.os }}
 
-    # XXX
-    # permissions:
-    #   contents: write
-
     env:
       toolchain: stable
 
     strategy:
       fail-fast: false
       matrix:
-        # https://doc.rust-lang.org/nightly/rustc/platform-support.html
+        # https://doc.rust-lang.org/stable/rustc/platform-support.html
         # https://github.com/rust-embedded/cross#supported-targets
+        # aarch64-apple-darwin (basically) requires macos-11 to be generally available.
         include:
           - target: x86_64-apple-darwin
             os: macos-latest
@@ -129,12 +128,12 @@ jobs:
 
       - name: Create tarball
         run: |
-          TAR_FILE=`python -m release tarball --target ${{ matrix.target }}`
-          tar -tvf $TAR_FILE
-          echo "tar_file=$TAR_FILE" >> $GITHUB_ENV
-
-      # XXX
-      # - name: Upload tarball
-      #   run: gh release upload ${{ needs.details.outputs.tag }} ${{ env.tar_file }} --clobber
-      #   env:
-      #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          TARBALL_PATH=`python -m release tarball --target ${{ matrix.target }}`
+          du -h $TARBALL_PATH
+          tar -tvf $TARBALL_PATH
+          echo "tarball_path=$TARBALL_PATH" >> $GITHUB_ENV
+
+      - name: Upload tarball
+        run: gh release upload ${{ needs.details.outputs.tag }} ${{ env.tarball_path }} --clobber
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "python-launcher"
 description = "The Python launcher for Unix"
-version = "0.15.0"
+version = "0.16.0"
 authors = ["Brett Cannon <[email protected]>"]
 repository = "https://github.com/brettcannon/python-launcher"
 readme = "README.md"

Cargo.toml

@@ -20,71 +20,76 @@ requirements on the type of interpreter you want (e.g. 32-bit, framework build
 on macOS, etc.). The Python Launcher should be viewed as a tool of convenience,
 not necessity.
 
-## Documentation
+## Installation
 
-The general control flow for finding the appropriate Python executable is the
-following (with Python 3.6, Python 3, and the newest version of Python installed
-as examples):
+### Via `cargo`
 
-<img src="https://raw.githubusercontent.com/brettcannon/python-launcher/main/docs/control-flow/control_flow.svg">
+If you have the latest stable
+[release of Rust](https://www.rust-lang.org/tools/install) installed, then you
+can install the [Python Launcher via crates.io](https://crates.io/crates/python-launcher):
 
-See the top section of
-`py --help` or the
-[man page](https://github.com/brettcannon/python-launcher/blob/main/docs/man-page/py.1.md)
-for more details.
+```
+cargo install python-launcher
+```
 
-## FAQ
+If you get a compilation error then it's very likely you don't have the latest
+stable release of Rust as there is a
+[release every 6 weeks](https://github.com/rust-lang/rfcs/blob/master/text/0507-release-channels.md)
+and this project tracks Rust's stable channel closely.
 
-### How do I install the Launcher?
+### From a `.tar.xz` file
 
-You can either install from [crates.io](https://crates.io/) or from source.
-Both approaches require you install the Rust toolchain. You can use
-[rustup](https://rustup.rs/) to accomplish this or whatever your OS suggests.
-Do note that if the compilation fails then your version of Rust is probably too
-old; while the project is always compatible with the stable version of Rust, it
-can update as quickly as the day of a new stable release of Rust.
+If you go to the
+[releases page](https://github.com/brettcannon/python-launcher/releases) you will
+find various `.tar.xz` files for each release that target various platforms. If
+one is available for your platform then you can download the tarball and install
+it into e.g. `/usr/local/` via:
 
-#### From crates.io
+```
+tar --extract --strip-components 1 --directory /usr/local --file <tarball>
+```
 
-If you want to
-[install from crates.io](https://crates.io/crates/python-launcher), run:
+You can use `tar -t -f <tarball>` to see what files are included and where they
+will be installed.
 
-```shell
-cargo install python-launcher
-```
+If you don't want to install the tarball then you can extract the tarball
+and copy the files manually as desired; the `py` binary is self-contained and is
+not dependent on any other files from the tarball.
 
-#### From source
 
-If you want to install from source, you can either use `cargo` directly:
+### From [source](https://github.com/brettcannon/python-launcher/)
 
-```shell
+#### Using [`cargo`](https://doc.rust-lang.org/cargo/)
+
+```
 cargo install --path .
 ```
 
-Or you can use `doit` to do the install only if source code as changed since
-the last time you used the `install` command:
+#### Using [`doit`](https://pydoit.org/)
+
+[Doit](https://pydoit.org/) will only perform an installation if source code as
+changed since the last time you used the `install` command:
 
-```shell
+```
 doit install
 ```
 
-### How do I get shell completions for [fish](https://fishshell.com/)?
+## Documentation
 
-The [`completions/py.fish` file in the repository](https://github.com/brettcannon/python-launcher/blob/main/completions/py.fish)
-provides completions for the Launcher. Beyond the statically-known completions
-(e.g. `--list`), the completions are also system-specific by providing version
-completions tied to the running shell (e.g. `-3.9` is only a completion if
-Python 3.9 is installed and will list the path to the Python executable that
-would be used). Completions for `python` itself are also included
-(although they are generic to Python itself, so all options may not be valid
-for the version of Python you will be launching).
+The general control flow for finding the appropriate Python executable is the
+following (with Python 3.6, Python 3, and the newest version of Python installed
+as examples):
 
-<img width="537" alt="fish_completions" src="https://user-images.githubusercontent.com/54418/113020397-6a71be00-9137-11eb-9047-2df1022592fa.png">
+<img src="https://raw.githubusercontent.com/brettcannon/python-launcher/main/docs/control-flow/control_flow.svg">
 
-See [fish's documentation on where to put completions](https://fishshell.com/docs/current/completions.html#where-to-put-completions)
-to know where the file should be copied/symlinked.
+See the top section of
+`py --help` or the
+[man page](https://github.com/brettcannon/python-launcher/blob/main/docs/man-page/py.1.md)
+for more details.
 
-### How do I have [Starship](https://starship.rs/) use the Launcher to display the Python version?
+## FAQ
+
+### How do I have [Starship](https://starship.rs/) use the Python Launcher to display the Python version?
 
 Add the following to your [Starship configuration file](https://fishshell.com/docs/current/completions.html#where-to-put-completions):
 
@@ -112,14 +117,10 @@ Do note that the character that is being split on is **not** the traditional
 [U+007C/"Vertical Line"/pipe character](https://www.compart.com/en/unicode/U+007C) (`|`),
 but [U+2502/"Box Drawings Light Vertical"](https://www.compart.com/en/unicode/U+2502) (`│`).
 
-## TODO
-
-[Issues to finish to reach MVP](https://github.com/brettcannon/python-launcher/milestone/1)
-
 ## Appendix
 
 - [PEP 397: Python launcher for Windows](https://www.python.org/dev/peps/pep-0397/)
 - [PEP 486: Make the Python Launcher aware of virtual environments](https://www.python.org/dev/peps/pep-0486/)
-- Windows Launcher
+- Python Launcher for Windows
   - [Documentation](https://docs.python.org/3/using/windows.html#launcher)
   - [Source](https://github.com/python/cpython/blob/master/PC/launcher.c)