Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Dependabot support and update KaTeX #3298

Merged
merged 6 commits into from
Jun 25, 2024
Merged

Add Dependabot support and update KaTeX #3298

merged 6 commits into from
Jun 25, 2024

Conversation

d-torrance
Copy link
Member

We add support for Dependabot to keep our GitHub actions and the npm modules used for the two Javascript syntax highlighting lexers up-to-date.

Once the file .github/dependabot.yml has been merged into the master branch, we will get automated PR's on occasion when any of these modules are updated.

For example, here are the PR's that I got on my branch when I tested it out:

I went ahead merged all these and included the commits in this PR.

@mikestillman mikestillman requested a review from mahrud June 16, 2024 17:22
@mikestillman
Copy link
Member

@mahrud Could you review this PR?

@mahrud
Copy link
Member

mahrud commented Jun 16, 2024

I'm not very familiar with dependabot, but few suggestions that come to mind:

  • Would changing the schedule to every month or even 6 months be better?
  • Could we combine all the PRs into one? Seems like it's possible.
  • There are a few other javascript packages embedded in the packages, namely prism and katex in Style and a whole bunch in Visualize. Is it possible to keep some of those updated as well?

@d-torrance
Copy link
Member Author

d-torrance commented Jun 16, 2024 •
edited
Loading

Yeah, less frequent updates is probably better. The examples all use weekly, so I just ran with it.

I think Visualize and Style support would be good, too. I have draft branches for both.

@d-torrance
Copy link
Member Author

I've changed the interval to monthly and also set the PR's to be grouped.

@d-torrance
Copy link
Member Author

I went ahead and added the KaTeX update to this PR. Visualize is going to need quite a bit of work to update.

@d-torrance d-torrance changed the title Add Dependabot support Add Dependabot support and update KaTeX Jun 17, 2024
mahrud
mahrud approved these changes Jun 17, 2024
View reviewed changes
Copy link
Member

@mahrud mahrud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's try this for a while, worse case we can disable it if there are too many PRs.

d-torrance and others added 6 commits June 21, 2024 10:23
@d-torrance
Add package.json in Style to update KaTeX
e5f22f1
@d-torrance
Add dependabot support
feaa78e
@dependabot @d-torrance
Bump the prism-dependencies group (#9)
9d3d653 
Bumps the prism-dependencies group in /M2/Macaulay2/editors/prism with 2 updates: [css-loader](https://github.com/webpack-contrib/css-loader) and [style-loader](https://github.com/webpack-contrib/style-loader).


Updates `css-loader` from 6.11.0 to 7.1.2
- [Release notes](https://github.com/webpack-contrib/css-loader/releases)
- [Changelog](https://github.com/webpack-contrib/css-loader/blob/master/CHANGELOG.md)
- [Commits](webpack-contrib/css-loader@v6.11.0...v7.1.2)

Updates `style-loader` from 3.3.4 to 4.0.0
- [Release notes](https://github.com/webpack-contrib/style-loader/releases)
- [Changelog](https://github.com/webpack-contrib/style-loader/blob/master/CHANGELOG.md)
- [Commits](webpack-contrib/style-loader@v3.3.4...v4.0.0)

---
updated-dependencies:
- dependency-name: css-loader
  dependency-type: direct:development
  update-type: version-update:semver-major
  dependency-group: prism-dependencies
- dependency-name: style-loader
  dependency-type: direct:development
  update-type: version-update:semver-major
  dependency-group: prism-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@d-torrance
Update KaTeX to 0.16.10
202638e
@d-torrance
Remove link to nonexistent KaTeX CSS file
b938354 
It was removed in KaTeX 0.16.0
@d-torrance
Remove code for old webpack-generated highlight.js
3c09a57 
This was formerly used in the Style package but was replaced by Prism
some time ago.

Also simplify the highlightjs README by pointing to the
highlightjs-macaulay2 repository.
@d-torrance
Copy link
Member Author

I realized that we don't need all the dependencies for the highlight.js any more -- that was just cruft left over from before we switched to prism for syntax highlighting the documentation. I went ahead and removed all that.

mahrud
mahrud reviewed Jun 21, 2024
View reviewed changes
M2/Macaulay2/editors/highlightjs/README.md
```

Both build systems will save the file in `Macaulay2/editors/highlightjs`.
See https://github.com/d-torrance/highlightjs-macaulay2 for more information.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's just a README file and no actual generation code then maybe just delete this directory and put a link to your repo on wiki.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We still need macaulay2.js.in to re-generate the source with new symbols every release.

Copy link
Member

@mahrud mahrud Jun 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we don't actually use highlight.js anymore, does that need to be in this repository? We could even move the generateGrammar function from make-M2-symbols.m2 to Style so that any M2 binary can generate macaulay2.js, without needing the whole repository, and it doesn't have to be at release, just whenever someone wants it, with whatever preloaded packages they desire.

mahrud
mahrud reviewed Jun 21, 2024
View reviewed changes
.github/dependabot.yml
- "*"

- package-ecosystem: "npm"
directory: "/M2/Macaulay2/editors/prism"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make more sense to also move every file other than macaulay2.js.in and perhaps README.md to Style? Then prism and katex can update together and the build target in this directory will generate the grammar file and copy it into the Style package.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I though about that too. I'll play around with it.

@mahrud
Copy link
Member

mahrud commented Jun 21, 2024

Here's a suggestion:

  • publish make-M2-symbols.m2 in Style (which currently doesn't have any M2 code, but this makes sense as an addition).
  • have makePackageIndex also regenerate prism.js based on preloaded packages along with .Macaulay2/index.html.
  • could even regenerate the emacs wordlist, either in-place or have an add-on list in .Macaulay2.

@DanGrayson DanGrayson merged commit 8a07ebc into Macaulay2:development Jun 25, 2024
6 checks passed
@d-torrance d-torrance mentioned this pull request Jun 25, 2024
Merged
@mahrud mahrud mentioned this pull request Jun 25, 2024
Open
@d-torrance d-torrance deleted the dependabot branch September 3, 2024 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mahrud mahrud mahrud approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@d-torrance @mikestillman @mahrud @DanGrayson