Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions packages/chebfun.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
layout: "package"
permalink: "chebfun/"
description: >-
Preview of Chebfun, numerical computing with functions, packaged for GNU Octave.

Check failure on line 5 in packages/chebfun.yaml

View workflow job for this annotation

GitHub Actions / check-yaml

5:81 [line-length] line too long (82 > 80 characters)
icon: "https://www.chebfun.org/images/logo.png"
links:
- icon: "far fa-copyright"
label: "BSD-3-Clause"
url: "https://github.com/gnu-octave/chebfun/blob/octave-dev/LICENSE"
- icon: "fas fa-rss"
label: "news"
url: "https://github.com/gnu-octave/chebfun/blob/octave-dev/octave_pkg/NEWS"
- icon: "fas fa-code-branch"
label: "repository"
url: "https://github.com/gnu-octave/chebfun/"
- icon: "fas fa-book"
label: "package documentation"
url: "https://chebfun.org"
- icon: "fas fa-bug"
label: "report a problem"
url: "https://github.com/gnu-octave/chebfun/issues"
maintainers:
- name: "Colin B. Macdonald"
contact:
- name: "Thomas Kolman"
contact:
versions:
- id: "dev"
date: "2025-08-31"
sha256: "TODO"
url: "TDDO"
depends:
- "octave (>= 11.0.0)"
- "pkg"
Copy link
Member

@mmuetzel mmuetzel Aug 29, 2025

Choose a reason for hiding this comment

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

There are package files that contain a section for development versions. E.g., the tablicious package:

- id: "dev"
date:
sha256:
url: "https://github.com/apjanke/octave-tablicious/archive/main.tar.gz"
depends:
- "octave (>= 7.0.0)"
- "pkg"

If I understand correctly, they set the .yaml file up to use the tarball that is dynamically generated by git (or GitHub?) for the head of a given branch. They left the date and the sha256 fields empty. That is probably a good idea for a "rolling version" that can change at any time.
I'd guess it would be ok to have that as the first section of versions - at least for some time. That first section is used as the default source when a user installs the package with pkg install -forge chebfun.
Once a first release is made, a new section describing that release could be added before the id: "dev" section.

Copy link
Contributor Author

@cbm755 cbm755 Aug 29, 2025

Choose a reason for hiding this comment

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

Thanks @mmuetzel

Our source code isn't a valid Octave package (no inst/ structure) so we can't quite use the github dynamically-generated tarball (we need to run a little script: https://github.com/gnu-octave/chebfun/blob/octave_dev/octave_pkg/make_oct_pkg.sh)

The issue tracking all this is gnu-octave/chebfun#1

Good tip about leaving sha256 blank for rolling "dev".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems CI is unhappy with the lack of sha256:

image

Copy link
Member

Choose a reason for hiding this comment

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

Hmm. That might be an issue with the CI rules...
Maybe, we could demote that into a warning if the "expected" checksum is empty...

Copy link
Member

Choose a reason for hiding this comment

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

I opened #616 (untested) that should demote the error to a warning in the CI check if the sha256 checksum is empty.

---
Loading