8000 Update release guide by melissawm · Pull Request #491 · napari/docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update release guide #491

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
8000
Merged
merged 7 commits into from
Sep 26, 2024
Merged

Update release guide #491

merged 7 commits into from
Sep 26, 2024

Conversation

melissawm
Copy link
Member

References and relevant issues

N/A

Description

Updated release notes generation instructions and removed outdated information.

Also deletes the obsolete script that was used to generate release notes, replaced now by the script in napari-release-tools.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 4, 2024
@melissawm
Copy link
Member Author

I'd love some input in the translations and packaging sections, as I don't know what happens there. The constraints section has been recently updated so should be ok.
8000

jni
jni reviewed Sep 4, 2024
View reviewed changes
jni
jni reviewed Sep 4, 2024
View reviewed changes
jni
jni reviewed Sep 4, 2024
View reviewed changes
@jni
Copy link
Member
jni commented Sep 4, 2024

I'd love some input in the translations and packaging sections, as I don't know what happens there.

Translations are unmaintained and will remain so until the software is more mature. I had a discussion about this with @goanpeca (that I neglected to post about sorry 😞) where we decided that it didn't make sense to spend so much maintenance effort when many of these strings (e.g. deprecation messages) will actually disappear before any translation even sees the light of day. (Currently, there are no localised binaries available at all.)

Packaging I'm less sure of but my understanding is that @jaimergp and @goanpeca maintain some CI recipes that get triggered during the GH Release build process.

In general, indeed it would be good for this page to have more notes about what's actually happening. ("When a tag gets pushed, it triggers THIS workflow, which pushes artifacts to PyPI using TRUSTED PUBLISHERS, which can be configured by STEERING COUNCIL." "Within 24h, the release will be picked up by the conda-forge bot, which will make a PR like THIS ONE. You should check that the PR dependencies match any recent changes to the PYPROJECT.TOML dependencies."

Finally, the thing that is still missing is that the version_chooser.json and the symlink must be updated manually. Ideally we would automate that but in the meantime, we should document it.
8000

@jni jni added this to the 0.5.4 milestone Sep 4, 2024
@melissawm
Copy link
Member Author

Perfect, will add those. Thanks!

@melissawm
Copy link
Member Author

@jaimergp @goanpeca can you help me with the packaging section? Thanks!

@jaimergp
Copy link
Contributor

I think we have some content for that in https://napari.org/stable/developers/coredev/packaging.html already. Maybe we just need to rehash some of the details in a more "workflow-y" way. The basics:

  1. The PyPI release will end up triggering the automated PR on conda-forge feedstock, where we will review the recipe (mostly making sure that the dependencies are in sync) and merge. ~30 mins after the merge, the package should be ready to conda install.
  2. The GH Release event will also trigger the workflow to build the installers. This is done without waiting for conda-forge to reduce the churn, so we build identical napari packages for the new version in our CI and deploy it to our internal channel. Then the same workflow will pick those from the CI cache, run constructor on them and push them to the GH Releases page.

@melissawm
Update release guide
8d9f9ad 
Updated release notes generation instructions and removed outdated information.

Also deletes the obsolete script that was used to generate release notes, replaced now by the script in napari-release-tools.
@melissawm
Update wording and move translation section to core developers guide
039e3e9
@melissawm
Update instructions for version switcher and docs releases
4a72348
@melissawm
Add some release/packaging notes
20ace14
jni
jni reviewed Sep 13, 2024
View reviewed changes
jaimergp
jaimergp reviewed Sep 19, 2024
View reviewed changes
@jni @jaimergp
typo fix: recipes -> recipe
1122990 
Co-authored-by: jaimergp <jaimergp@users.noreply.github.com>
@jni jni merged commit f5a4691 into napari:main Sep 26, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jaimergp jaimergp jaimergp left review comments

@jni jni jni approved these changes

Assignees

@melissawm melissawm

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.5.4
Development

Successfully merging this pull request may close these issues.
3 participants
@melissawm @jni @jaimergp
0