🚀 Add release action to GitHub CI (#519)

* 📖 Add python-specific readme
* 🚴‍♀️ Add release action
* ✨ Python code formatting
* 🔼 Swap update command based on myst language env var
* 🐍 Bump python version with changeset version bump

Author: fwkoch

.github/workflows/release.yml

@@ -0,0 +1,45 @@
+name: Release
+
+on: workflow_dispatch
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+          submodules: recursive
+      - name: Install libxml
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libxml2-utils
+      - name: Setup Node.js 18.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+      - name: Install node deps
+        run: npm install
+      - name: Run build
+        run: npm run build
+      - name: Run tests
+        run: npm run test
+      - name: Version bump and publish to npm
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          version: npm run version
+          publish: npm run publish
+          commit: 🚀 Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Publish to PyPI
+        if: steps.changesets.outputs.published == 'true'
+        run: |
+          cd packages/mystmd-py
+          bash scripts/pypi-deploy.sh

package.json

@@ -13,7 +13,7 @@
     "test": "turbo run test",
     "format": "prettier --write \"**/*.{ts,tsx,md}\"",
     "changeset": "changeset",
-    "version": "changeset version && npm install",
+    "version": "changeset version && npm install && cd packages/mystmd-py && bash scripts/bump-version.sh",
     "publish": "npm run clean && npm run build -- --force && changeset publish && git push --follow-tags"
   },
   "devDependencies": {

packages/myst-cli/src/session/session.ts

@@ -18,6 +18,8 @@ import version from '../version.js';
 
 const CONFIG_FILES = ['myst.yml'];
 const API_URL = 'https://api.mystmd.org';
+const NPM_COMMAND = 'npm i -g mystmd@latest';
+const PIP_COMMAND = 'pip install -U mystmd';
 
 export function logUpdateAvailable({
   current,
@@ -81,7 +83,7 @@ export class Session implements ISession {
       logUpdateAvailable({
         current: version,
         latest: this._latestVersion,
-        upgradeCommand: 'npm i -g mystmd@latest',
+        upgradeCommand: process.env.MYST_LANG === 'PYTHON' ? PIP_COMMAND : NPM_COMMAND,
         twitter: 'MystMarkdown',
       }),
     );

packages/mystmd-py/.gitignore

@@ -1,5 +1,4 @@
 src/version.ts
 *.egg-info
 dist
-mystmd_py/myst.cjs
-README.md
+mystmd_py/myst.cjs

packages/mystmd-py/README.md

@@ -0,0 +1,44 @@
+# MyST Markdown Command Line Interface, `mystmd`
+
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/executablebooks/mystmd/blob/main/LICENSE)
+![CI](https://github.com/executablebooks/mystmd/workflows/CI/badge.svg)
+
+`mystmd` is a set of open-source, community-driven tools designed for scientific communication, including a powerful authoring framework that supports blogs, online books, scientific papers, reports and journals articles.
+
+> **Note**
+> The `mystmd` project is in **beta**. It is being used to explore a full MyST implementation and will change significantly and rapidly.
+> The project is being developed by a small team of people on the Executable Books Project, and may make rapid decisions without fully public/inclusive discussion.
+> We will continue to update this documentation as the project stabilizes.
+
+## Overview
+
+The `mystmd` project provides a command line tool (`mystmd`) for working with MyST Markdown projects.
+
+- Provides functionality for cross-referencing, external structured links, and scientific citations
+- Translate and render MyST Markdown into:
+  - HTML for static websites, and modern React for interactive websites (like this website!)
+  - PDFs and LaTeX documents, with specific templates for over 400 journals
+  - Microsoft Word export
+- Parse MyST into a standardized AST, that follows the MyST Markdown Spec
+
+See the [documentation](https://mystmd.org/guide).
+
+## Get Started
+
+The MyST Markdown CLI is available through PyPI:
+
+```bash
+pip install mystmd
+myst init
+myst build my-doc.md --tex
+```
+
+and Conda:
+
+```bash
+conda config --add channels conda-forge
+conda config --set channel_priority strict
+conda install mystmd
+myst init
+myst build my-doc.md --tex
+```

packages/mystmd-py/mystmd_py/main.py

@@ -1,46 +1,42 @@
+import os
 import pathlib
 import shutil
 import subprocess
 import sys
 
 
 NODE_LOCATION = (
-    shutil.which("node") or
-    shutil.which("node.exe") or
-    shutil.which("node.cmd")
-)
-PATH_TO_BIN_JS = str(
-    (
-        pathlib.Path(__file__).parent / 'myst.cjs'
-    ).resolve()
+    shutil.which("node") or shutil.which("node.exe") or shutil.which("node.cmd")
 )
+PATH_TO_BIN_JS = str((pathlib.Path(__file__).parent / "myst.cjs").resolve())
 
 
 def main():
     if not NODE_LOCATION:
         sys.exit(
-            'You must install node >=16 to run MyST\n\n'
-            'We recommend installing the latest LTS release, using your preferred package manager\n'
-            'or following instructions here: https://nodejs.org/en/download'
+            "You must install node >=16 to run MyST\n\n"
+            "We recommend installing the latest LTS release, using your preferred package manager\n"
+            "or following instructions here: https://nodejs.org/en/download"
         )
     node = str(pathlib.Path(NODE_LOCATION).resolve())
     version_proc = subprocess.Popen(
-        [node, '-v'], 
-        stdin=subprocess.PIPE, stdout=subprocess.PIPE
+        [node, "-v"], stdin=subprocess.PIPE, stdout=subprocess.PIPE
     )
     version_proc.wait()
     version = version_proc.communicate()[0].decode()
     try:
-        ['16', '18', '20'].index(version[1:3])
+        ["16", "18", "20"].index(version[1:3])
     except:
         sys.exit(
-            f'MyST requires node 16, 18, or 20; you are running node {version[1:3]}.\n\n'
-            'Please update to the latest LTS release, using your preferred package manager\n'
-            'or following instructions here: https://nodejs.org/en/download'
+            f"MyST requires node 16, 18, or 20; you are running node {version[1:3]}.\n\n"
+            "Please update to the latest LTS release, using your preferred package manager\n"
+            "or following instructions here: https://nodejs.org/en/download"
         )
     myst_proc = subprocess.Popen(
         [node, PATH_TO_BIN_JS, *sys.argv[1:]],
-        stdin=sys.stdin, stdout=sys.stdout
+        stdin=sys.stdin,
+        stdout=sys.stdout,
+        env={**os.environ, "MYST_LANG": "PYTHON"},
     )
     sys.exit(myst_proc.wait())
 

packages/mystmd-py/scripts/bump-version.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+CURRENT=`awk -F'"' '/"version": ".+"/{ print $4; exit; }' ../mystmd/package.json`
+PREVIOUS=`awk -F' ' '/version = .+/{ print $3; exit; }' setup.cfg`
+echo "bumping mystmd-py: $PREVIOUS => $CURRENT"
+sed -i "" "s/$PREVIOUS/$CURRENT/" setup.cfg

packages/mystmd-py/scripts/pypi-deploy.sh

@@ -1,9 +1,6 @@
 #!/bin/bash
-cp ../mystmd/README.md .
+bash ./scripts/bump-version.sh
 cp ../mystmd/dist/myst.cjs mystmd_py
-CURRENT=`awk -F'"' '/"version": ".+"/{ print $4; exit; }' ../mystmd/package.json`
-PREVIOUS=`awk -F' ' '/version = .+/{ print $3; exit; }' setup.cfg`
-sed -i "" "s/$PREVIOUS/$CURRENT/" setup.cfg
 rm -rf dist
 python -m build
 python -m twine upload dist/*

packages/mystmd-py/setup.cfg

@@ -1,7 +1,8 @@
 [metadata]
 name = mystmd
-version = 0.0.6
+version = 1.1.7
 description = Command line tools for MyST Markdown
+long_description = file: README.md
 author = Franklin Koch
 url = https://github.com/executablebooks/mystmd
 license = MIT