Test for MNE-Tools actions

[tsbinns]

Testing to get an idea of how the actions being implemented in MNE-Tools behave (mne-tools/mne-tools#20).

[tsbinns]

Have now tested here all the actions implemented so far in mne-tools, save the old env checking.

There are a couple differences between what happens currently and what the actions do, but only cosmetic, nothing that should affect the function. A summary of differences below:

Syncing dependencies to env yaml

• Formatting of some specifiers/markers changes because the actions uses packaging's Request object to get str reprs, which has its own ordering logic. However, this is just a cosmetic thing, and it still functions as an env file.

Citation generation

• Action switches to using pyyaml to format CITATION.CFF instead of manually constructing this. However, pyyaml's behaviour is to not indent lists, e.g.:

# `pyyaml` formatting
my-list:
- item

# current formatting
my-list:
  - item

AFAIK, there isn't a way to get pyyaml to add this indentation. Both are valid yaml formats, just a visual thing, but it does produce a big diff to what there is currently.

• pyyaml also doesn't wrap multi-word strings in quotes, as is currently done, but this isn't required for the yaml to be valid.

• Action takes keywords from pyproject.toml, which don't match what is currently used in the citation. Idea was to simplify the args that need to be passed to the action (as specifying loads of keywords gets cumbersome) and this info can be encoded in pyproject.toml.

Codemeta generation

• Action uses keywords encoded in pyproject.toml rather than requiring these to be passed as args, as well as supported OSs (which can be extracted from the classifier field) and package description. Again, just trying to simplify args by using info already encoded somewhere.

• Action uses json.dump() to construct codemeta.json rather than manually building this. Ends up fixing some indent and spacing inconsistencies in author names. A cosmetic improvement, but does generate a big diff.

[larsoner]

Those whitespace changes would be okay but in its current form this is a bit tough to review since it just shows a diff... WDYT about putting all of those actions in the autofix.ci job? That way all the proposed changes will actually be committed? I think it's the way we'll probably want to use it in practice anyway, and will facilitate seeing the diffs (e.g., with whitespace changes ommitted or not).

[tsbinns]

pip-pre failure should be fixed in #14139

[larsoner]

#14133 does change some of the naming / compound surname stuff. Okay for me to merge that one after this one or vice-versa

[larsoner]

CircleCI now uses two files from this repo (here and down in circleci_bash_env.sh). Better maybe to use a standard checkout step to a known directory and then use both from there?

[tsbinns]

Originally I avoided relying on setup_xvfb.sh being already available for circleci_bash_env.sh, in case there were other packages using this which would need to be updated. However, I subsequently found that only MNE-Conn is using it: #13971 (comment)

[tsbinns]

If we go back to circleci_bash_env.sh assuming setup_xvfb.sh is already present and the only downstream change would be in MNE-Conn, that's easy enough I guess. WDYT?

[tsbinns]

@larsoner Would you prefer I remove the setup_xvfb.sh curl in circleci_bash_env.sh and fix downstream in MNE-Connecitivity, or can I leave this here?

[tsbinns]

#14133 does change some of the naming / compound surname stuff. Okay for me to merge that one after this one or vice-versa

Sure, happy with either order. Whichever is in a mergeable state first

[larsoner]

Okay #14133 is in

[tsbinns]

Okay #14133 is in

Added to the compound surnames in .extendec_metadata.yaml, and will open a PR excluding Lumberbot along with the bash shell changes to mne-tools.

[tsbinns]

mne-tools/mne-tools#42 fixes the conda env availability for the check-qt-action and removes Lumberbot from codemeta and citation files.