metanorma/chocolatey-latexml

Chocolatey package for LaTeXML

chocolatey-latexml: Chocolatey install for LaTeXML

• main branch - for stable releases

• beta branch - for releases from https://github.com/brucemiller/LaTeXML git

Modifying the package

1. Edit the latexml.nuspec configuration file.

2. Edit the ./tools/chocolateyInstall.ps1 install script

3. Edit the ./tools/chocolateyUninstall.ps1 uninstall script

4. You must save your files with UTF-8 character encoding without BOM.

Building the package

• Run choco pack in the same directory as latexml.nuspec

Note	If you are running this from a command prompt/Powershell prompt, you must run it “as Administrator”.

Testing the package

Note	Testing should be done on a Virtual Machine (See: https://github.com/chocolatey/chocolatey-test-environment)

In the package directory, use:

• choco install latexml -dv -s "'$pwd;https://chocolatey.org/api/v2/'" -f (Powershell)

• choco install latexml -dv -s "'%cd%;https://chocolatey.org/api/v2/'" -f (everywhere else)

Or, use the full path:

• choco install latexml -source 'c:\path\to\package' -f

After executing the install, ensure that latexml.exe is installed by executing the following command from the command prompt:

latexml version

If it is properly installed, you will see the current version of LaTeXML.

Testing uninstallation

Note	The Chocolatey install path on Windows is typically C:\ProgramData\chocolatey

Execute the following command to uninstall LaTeXML.

choco uninstall latexml -y

After executing the uninstall ensure that latexml is not found in the Chocolatey install path.

You can also try running latexml --VERSION from the command-line to see if it is still installed

Publish the package to the Chocolatey community feed repository

choco apikey -k [API_KEY_HERE] -source https://chocolatey.org/`

# package name can be omitted below
choco push latexml.[version num].nupkg -s https://chocolatey.org/

Installation from official repository

choco install latexml -y

or

cinst latexml -y

See the Chocolatey Packages Quick Start for more information.

See the Chocolatey Packages Quick Start for more information.

chocolatey-latexml's Issues

Setup appveyor

@ronaldtse please add project to appveyor and give me a link to build status icon

remote: Permission to metanorma/chocolatey-latexml.git denied to metanorma-ci.

https://github.com/metanorma/chocolatey-latexml/runs/4209433199?check_suite_focus=true

@ronaldtse could you please doublecheck METANORMA_CI_PAT_TOKEN permissions for this repo

P.S. also could you please rename default branch master -> main from settings

Migrate this repository to github.com/metanorma

The repository github.com/metanorma has been set up to host all Metanorma related work. This is one such piece of work. While the migration will be slow (there is a lot to do, and a lot of interdependencies), we need to schedule migration for all related repositories.

Add Chocolatey LaTeXML test when MiKTeX is installed

According to metanorma/metanorma.org#83 , these packages in LaTeXML depend on external TeX distribution.

color.sty
colordvi.sty
ntheorem.sty
pgfkeys.code
pgfmath.code
siunitx.sty
tikz.sty
xcolor.sty

So the test for testing integration with MiKTeX could use any of these packages, such as ntheorem or color.

For xcolor, @dginev says:

Currently latexml won't stop you from using a package that may require a tex distribution, since in some cases you skirt away from the dependency. For instance xcolor only requires the tex distribution if you use the extended option set, but would be OK without one if you just load it with no options.

Originally posted by @ronaldtse in #7 (comment)

Remove dependency of MiKTeX

As described by @dginev here https://chocolatey.org/packages/miktex#comment-4420594892 , the Chocolatey MiKTeX installation binary changes location (path) on every release. There is a large time gap between "MiKTeX release" and "Chocolatey MiKTeX package release", which renders our package unusable (unable to install MiKTeX).

While there is TeXLive on Windows, their Chocolatey package is severely outdated (from 2012) and unusable.

From discussions we have decided to remove the dependency of the TeX system from this package, since LaTeXML can function without it. The user can choose whatever TeX distribution they want and have to install manually.

Ref:

From @brucemiller:

For Windows & Chocolatey, maybe that latter approach
makes the most sense for LaTeXML itself --- omit the
dependency and let the users install what they like,
even outside of Chocolatey.

From me:

I think this might be the best choice. Let the user decide their own setup. What we could do is to test Chocolatey LaTeXML under both cases: if a TeX distribution is or is not present.

This task is to :

1. Remove dependency of MiKTeX from the package
2. Update AppVeyor tests to install a TeX distribution automatically (and share this AppVeyor with brucemiller/LaTeXML#1109 (comment) )

The command to call LaTeXML in PowerShell is not recognized

Hello, I posted the issue at brucemiller/LaTeXML#1853 and the developer referenced me to you.

In short the problem is that chocolatey says that the install was successful but the command is still not recognized.

Failed LaTeXML beta release on Chocolatey

From Chocolatey:

@CAMOBAP is this still valid? Thanks.

'latexml.beta' is Submitted.
Current status = Waiting for Maintainer to take corrective action

chocolatey-ops left the following comment(s):

latexml.beta has failed automated validation.

Requirements

Requirements represent the minimum quality of a package that is acceptable. When a package version has failed requirements, the package version requires fixing and/or response by the maintainer. Provided a Requirement has flagged correctly, it must be fixed before the package version can be approved. The exact same version should be uploaded during moderation review.

The package id includes a prerelease version name which should be included only in the version of the package. More...
Notes

Notes typically flag things for both you and the reviewer to go over. Sometimes this is the use of things that may or may not be necessary given the constraints of what you are trying to do and/or are harder for automation to flag for other reasons. Items found in Notes might be Requirements depending on the context. A package version can be approved without addressing Note comments.

The package id includes dots (.). Usually the package id is separated by '-' instead of dots (except in the case of *.install and *.portable). The reviewer will ensure this is not a new package. More...
Attention - DO NOT REPLY TO THIS MESSAGE!

No human moderators see packages until automated checks are passed or the maintainer uses the review comments box to respond. This is very important to understand, if a package has failed any automated checks, you must take action to fix or respond.
ATTENTION: If your package is failing any automated checks, the ONLY way to get in front of a human moderator is to follow the instructions in the next step.
If you need to update or respond to package review information, please login and visit your package page (listed below). Use the Add to Review Comments box ONLY, Disqus/Gist comments will not reach a human reviewer.
This may include review comments prior to the automated checks, check the status on the package - it must be in 'Ready' or 'Responded' to be in front of a human moderator.
You can also self-reject packages in certain scenarios - see self-reject for more information.
Package Url: https://chocolatey.org/packages/latexml.beta/0.8.4 
Maintainer(s): ribose

Maintainer Notes

If we've asked you to make changes, repush your updated package with the exact same version (unless the change we requested was based on an incorrect version).

iconUrl need to point to CDN

Currently, we use https://dlmf.nist.gov/LaTeXML/x7.png

Per review comment:

For the next package version can you please host the icon on your package sources and link to it via a CDN: https://docs.chocolatey.org/en-us/create/create-packages#package-icon-guidelines

@ronaldtse do you have any idea how to accomplish this, maybe already use some CDN where we can put this icon?

Convert to GHA

API key is now called secrets.CHOCOLATEY_API_KEY.

Package v0.8.6 rejected by Chocolatey

'latexml' is Rejected.
chocolatey-ops left the following comment(s):

Unfortunately there has not been progress to move latexml v0.8.6 towards an approved status within 15 days after the last review message, so we need to close (reject) the package version at this time. If you want to pick this version up and move it towards approval in the future, use the contact site admins link on the package page and we can move it back into a submitted status so you can submit updates.

Status Change - Changed status of package from 'submitted' to 'rejected'.

The package was rejected by chocolatey-ops on 14 Nov 2021.

Use another approach for beta releases

Initially, I have tried the approach with beta branch but it looks not very good to maintain

A better approach to do both stable and beta releases from main branch, to do this:

• update release-tag to correctly handle -pre versions
• update tools/chocolateyinstall.ps1 to correctly handle git install or zip install

Track LaTeXML tests on Windows

@dginev is currently addressing the problems we ran into here: brucemiller/LaTeXML#1109

• Failing comparisons due to `kpsewhich: warning: running with administrator privileges’
• A failing test with MiKTeX

Once that is merged/released we probably need an update.

Re-enable tests for Chocolatey LaTeXML package

Regarding:

chocolatey-latexml/tools/chocolateyinstall.ps1

Line 8 in 23648bc

& cpanm --notest --verbose LaTeXML@$Env:ChocolateyPackageVersion

From @brucemiller

It'd be a shame to disable tests, since that catches installation problems earlier rather than later.
Which tests produce this message?

@CAMOBAP795 could you help answer @brucemiller ? Thanks!