search

asdf-format / asdf

ASDF (Advanced Scientific Data Format) is a next generation interchange format for scientific data
http://asdf.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
511 stars 56 forks source link

Retire the "stable" branch #1760

Closed braingram closed 4 months ago

braingram commented 4 months ago

Should we retire the "stable" branch? Our release branches are considered stable so having this branch seems redundant.

@nden @perrygreenfield @eslavich any objection to retiring "stable"?

There are many references to the "stable" documentation that we should consider updating to point to "latest": https://github.com/search?q=org%3Aspacetelescope+https%3A%2F%2Fasdf.readthedocs.io%2Fen%2Fstable%2F&type=code

nden commented 4 months ago

The only use of the "stable" branch is to generate the "stable" docs as opposed to the "dev" docs. If we are doing this in some other way now, then we don't need it.

braingram commented 4 months ago

Thanks for the clarification. Is it safe to say "stable" should always point to the latest released version?

nden commented 4 months ago

Yes, that was the intention. I wonder if for the standard it makes sense to have documentation for the various versions. For the library I'd say we need the latest release only and "latest dev".

braingram commented 4 months ago

Thanks! I updated the release docs (with a note about promptly updating the "stable" branch as part of a release to keep the docs up-to-date).