📣 Rename of myst-cli to mystmd

[rowanc1]

The command line tools have been renamed from myst-cli to mystmd. This is to open up a consistent path in the future to installing via pip/conda (#139). This also consolidates our terminology and domain rename (e.g. see executablebooks/team-compass#21).

To upgrade to v1.1.0 of the MyST CLI you will need to:

npm uninstall -g myst-cli
npm install -g mystmd

For development

npm uninstall -g myst-cli
npm run build
npm run dev # This will relink the packages

If you have any problems, it may say there is a conflicting myst command, delete the file noted in the error log and build again.

[frenck]

It was rather surprising to see a breaking change happing in a minor release tbh, with absolutely 0 deprecation handling.

Is it planned to add structure to handling these things? Because the way this was done, is in my opinion not acceptable to end-users.

[rowanc1]

Thanks for the feedback, sorry this broke something on your end. I hope that the update should be straight forward, if you are on CI, change myst-cli to mystmd and everything should work again. We are continuing to use the myst-cli project for programmatic exports, but the export for the command line tool is no longer included in that npm package. In talking with folks on how to handle the name change we felt a clean break was better than supporting the same myst export in two packages, which makes conflicts and would lead to many other install problems.

These are some of the changes that are aiming to take us out of beta over the next few months. You are probably right that this could have been a major release, we will aim to be better in the future.

[frenck]

I hope that the update should be straight forward, if you are on CI, change myst-cli to mystmd and everything should work again.

The fix is easy, that is not the issue, but since it is used in workflows, it just breaks CI for others all of a sudden: Surprise!

TBH that is an issue with the way the new (documented/recommended) CI for GitHub Actions is made too... it isn't tied into a version of Myst Markdown, making it very very hard for you to break anything at any point in time in the future, as the end-user will always run the latest. This means you possibly have to maintain backwards compatibility for your end-users until the end of days?

we will aim to be better in the future.

❤️

[rowanc1]

I think that you are right about the GitHub action. We should probably maintain an action and release that with its own cadence. (See #453)

[rowanc1]

Closing now that this is a month old, we have also recently released mystmd on conda and pypi, which we will make an announcement about soon.