From e16fc6b5e396643e2136bdbe75d74959efbd3b56 Mon Sep 17 00:00:00 2001 From: John Kerl Date: Mon, 10 Jan 2022 22:48:21 -0500 Subject: [PATCH] Conda/Docker install notes --- docs/src/build.md | 7 ++++--- docs/src/build.md.in | 7 ++++--- docs/src/installing-miller.md | 9 +++++++++ docs/src/installing-miller.md.in | 9 +++++++++ todo.txt | 10 ++-------- 5 files changed, 28 insertions(+), 14 deletions(-) diff --git a/docs/src/build.md b/docs/src/build.md index 7422fee05..531d5f931 100644 --- a/docs/src/build.md +++ b/docs/src/build.md @@ -77,15 +77,15 @@ In this example I am using version 6.1.0 to 6.2.0; of course that will change fo * `make release_tarball` * This creates `miller-6.2.0.tar.gz` which we'll upload to GitHub, the URL of which will be in our `miller.spec` - * Get `mlr.{arch}` binaries from latest successful build from [https://github.com/johnkerl/miller/actions](https://github.com/johnkerl/miller/actions), or, build them on buildboxes. * Prepare the source RPM following [README-RPM.md](https://github.com/johnkerl/miller/blob/main/README-RPM.md). * Create the Github release tag: * Don't forget the `v` in `v6.2.0` * Write the release notes - * Attach the release tarball, binaries, and SRPM. Double-check assets were successfully uploaded. - * Publish the release + * Get binaries from latest successful build from [https://github.com/johnkerl/miller/actions](https://github.com/johnkerl/miller/actions), or, build them on buildboxes. Note that thanks to [PR 822](https://github.com/johnkerl/miller/pull/822) which introduces [goreleaser](https://github.com/johnkerl/miller/blob/main/.goreleaser.yml) there are versions for many platforms auto-built and auto-attached to the GitHub release (below). The only exception is for Windows: goreleaser makes a `.tar.gz` file but it's nice to attach a `.zip` from GitHub actions for the benefit of Windows users. + * Attach the release tarball, Windows `.zip`, and SRPM. Double-check assets were successfully uploaded. + * Publish the release. Note that gorelease will create and attach the rest of the binaries. * Check the release-specific docs: @@ -95,6 +95,7 @@ In this example I am using version 6.1.0 to 6.2.0; of course that will change fo * Submit `brew` pull request; notify any other distros which don't appear to have autoupdated since the previous release (notes below) * Similarly for `macports`: [https://github.com/macports/macports-ports/blob/master/textproc/miller/Portfile](https://github.com/macports/macports-ports/blob/master/textproc/miller/Portfile) + * See also [README-versions.md](https://github.com/johnkerl/miller/blob/main/README-versions.md) -- distros usually catch up over time but some contacts/pings never hurt to kick-start processes after owners move on from a project they started. * Social-media updates. 
diff --git a/docs/src/build.md.in b/docs/src/build.md.in
index fea41436a..f7f30ca6c 100644
--- a/docs/src/build.md.in
+++ b/docs/src/build.md.in
@@ -61,15 +61,15 @@ In this example I am using version 6.1.0 to 6.2.0; of course that will change fo
 
     * `make release_tarball`
     * This creates `miller-6.2.0.tar.gz` which we'll upload to GitHub, the URL of which will be in our `miller.spec`
-    * Get `mlr.{arch}` binaries from latest successful build from [https://github.com/johnkerl/miller/actions](https://github.com/johnkerl/miller/actions), or, build them on buildboxes.
     * Prepare the source RPM following [README-RPM.md](https://github.com/johnkerl/miller/blob/main/README-RPM.md).
 
 * Create the Github release tag:
 
     * Don't forget the `v` in `v6.2.0`
     * Write the release notes
-    * Attach the release tarball, binaries, and SRPM. Double-check assets were successfully uploaded.
-    * Publish the release
+    * Get binaries from latest successful build from [https://github.com/johnkerl/miller/actions](https://github.com/johnkerl/miller/actions), or, build them on buildboxes. Note that thanks to [PR 822](https://github.com/johnkerl/miller/pull/822) which introduces [goreleaser](https://github.com/johnkerl/miller/blob/main/.goreleaser.yml) there are versions for many platforms auto-built and auto-attached to the GitHub release (below). The only exception is for Windows: goreleaser makes a `.tar.gz` file but it's nice to attach a `.zip` from GitHub actions for the benefit of Windows users.
+    * Attach the release tarball, Windows `.zip`, and SRPM. Double-check assets were successfully uploaded.
+    * Publish the release. Note that gorelease will create and attach the rest of the binaries.
 
 * Check the release-specific docs:
 
@@ -79,6 +79,7 @@ In this example I am using version 6.1.0 to 6.2.0; of course that will change fo
 
     * Submit `brew` pull request; notify any other distros which don't appear to have autoupdated since the previous release (notes below)
     * Similarly for `macports`: [https://github.com/macports/macports-ports/blob/master/textproc/miller/Portfile](https://github.com/macports/macports-ports/blob/master/textproc/miller/Portfile)
+    * See also [README-versions.md](https://github.com/johnkerl/miller/blob/main/README-versions.md) -- distros usually catch up over time but some contacts/pings never hurt to kick-start processes after owners move on from a project they started.
     * Social-media updates.
 
 GENMD-CARDIFY
diff --git a/docs/src/installing-miller.md b/docs/src/installing-miller.md
index 6a84b2d95..20396e885 100644
--- a/docs/src/installing-miller.md
+++ b/docs/src/installing-miller.md
@@ -31,6 +31,12 @@ Using a package manager:
 * Windows: `choco install miller` using [Chocolatey](https://chocolatey.org).
 * Note: Miller 6 was released 2022-01-09; [several platforms](https://github.com/johnkerl/miller/blob/main/README-versions.md) may have Miller 5 available.
 
+See also:
+
+* [Conda](https://anaconda.org/conda-forge/miller).
+* [@jauderho](https://github.com/jauderho)'s [docker images](https://hub.docker.com/r/jauderho/miller/tags) as discussed in [GitHub Discussions](https://github.com/johnkerl/miller/discussions/851#discussioncomment-1943255)
+    * Example invocation: `docker run --rm -i jauderho/miller:latest --csv sort -f shape < ./example.csv`
+
 As a first check, you should be able to run `mlr --version` at your system's command prompt and see something like the following:
 
 
@@ -40,6 +46,9 @@ As a first check, you should be able to run `mlr --version` at your system's com
 mlr 6.0.0
 

 
+If you Miller version is not 6 or above, please see the [release docs
+page](release-docs.md) to find the documentation for your version.
+
 As a second check, given [example.csv](./example.csv) you should be able to do
 
 
diff --git a/docs/src/installing-miller.md.in b/docs/src/installing-miller.md.in
index 8b2db026f..942f6948e 100644
--- a/docs/src/installing-miller.md.in
+++ b/docs/src/installing-miller.md.in
@@ -15,12 +15,21 @@ Using a package manager:
 * Windows: `choco install miller` using [Chocolatey](https://chocolatey.org).
 * Note: Miller 6 was released 2022-01-09; [several platforms](https://github.com/johnkerl/miller/blob/main/README-versions.md) may have Miller 5 available.
 
+See also:
+
+* [Conda](https://anaconda.org/conda-forge/miller).
+* [@jauderho](https://github.com/jauderho)'s [docker images](https://hub.docker.com/r/jauderho/miller/tags) as discussed in [GitHub Discussions](https://github.com/johnkerl/miller/discussions/851#discussioncomment-1943255)
+    * Example invocation: `docker run --rm -i jauderho/miller:latest --csv sort -f shape < ./example.csv`
+
 As a first check, you should be able to run `mlr --version` at your system's command prompt and see something like the following:
 
 GENMD-RUN-COMMAND
 mlr --version
 GENMD-EOF
 
+If you Miller version is not 6 or above, please see the [release docs
+page](release-docs.md) to find the documentation for your version.
+
 As a second check, given [example.csv](./example.csv) you should be able to do
 
 GENMD-RUN-COMMAND
diff --git a/todo.txt b/todo.txt
index fb746b4b1..987c71277 100644
--- a/todo.txt
+++ b/todo.txt
@@ -1,27 +1,21 @@
 ================================================================
 PUNCHDOWN LIST
 
-* post-release:
-  ! conda
-  o windows should have a .zip not just a .tar.gz -- probably a manual step still (copy from GH artifacts)
-  w installing-miller.md.in
-
 * document cloudthings, e.g.
   o go.yml
   o codespell.yml
     - codespell --check-filenames --skip *.csv,*.dkvp,*.txt,*.js,*.html,*.map,./tags,./test/cases --ignore-words-list denom,inTerm,inout,iput,nd,nin,numer,Wit,te,wee
   o readthedocs triggers
-* update build docs re artifacts -- thanks to #821/#822 no need for buildboxing anymore :)
 * sync-print option; or (yuck) another xprint variant; or ...; emph dump/eprint
 ? trace-mode ?
 
 * release ordering?
-  o done: brew macports archlinux
+  o done: brew macports archlinux conda
   o todo:
-    conda
     chocolatey
     ubuntu debian fedora gentoo prolinux
     netbsd freebsd
+    README-versions.md
 
 ================================================================
 NON-BLOCKERS