Skip to content

Conversation

@cbm755
Copy link
Contributor

@cbm755 cbm755 commented Aug 29, 2025

This needs a few things, such as a tarball.

TODO list

  • tarball hosted somewhere
  • is ok to use id: "dev" before there is an actual release?
  • check the URLs

Many thanks to @kolmanthomas, who worked on this during GSoC 2025.


Worth emphasizing that this requires Octave 11.

Comment on lines 29 to 35
- 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.

@cbm755
Copy link
Contributor Author

cbm755 commented Aug 29, 2025

CI:

ERROR: pkg install -verbose chebfun@dev
  mkdir (/tmp/oct-JOZNat)
  untar (/tmp/oct-Eebx32/chebfun-5.7.0+.tar.gz, /tmp/oct-JOZNat)
  error: the following dependencies were unsatisfied:
     chebfun needs octave >= 11.0

This is exactly what should happen as we require Octave 11. ;-)

@cbm755
Copy link
Contributor Author

cbm755 commented Aug 29, 2025

Probably this is a bit premature; folks can test with a direct URL.

If its ok, I suggest we just leave it open as Draft: ... (but I can easily file again later too)

@siko1056 siko1056 added the new package New package to be added to the index label Oct 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new package New package to be added to the index

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants