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.

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

Add some more docs about packaging details and conda-forge releases #48

Merged
merged 11 commits into from
May 17, 2023

Conversation

jaimergp
Copy link
Contributor

Description

The packaging docs needed some subtle changes in wording and content.

  • I removed some unnecessarily condescending words like "simply" or "just"
  • Added more links
  • Sections to distinguish conda-forge from PyPI
  • Added some conda-forge details to the release guide

Type of change

  • Bug-fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

References

Closes napari/packaging#2

How has this been tested?

  • example: the test suite for my feature covers cases x, y, and z
  • example: all tests pass with my change

Final checklist:

  • My PR is the minimum possible work for the desired functionality
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • If I included new strings, I have used trans. to make them localizable.
    For more information see our translations guide.

Side question: is the issue template accurate for this repository? It feels we could have a more relatable one :D

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 13, 2022
@jaimergp
Copy link
Contributor Author

jaimergp commented Jan 9, 2023

Anything else needed here so this gets merged? 🙏

Copy link
Member

@psobolewskiPhD psobolewskiPhD left a comment

Choose a reason for hiding this comment

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

To me this is all clear. I can't say I've tested it though.
I've made the most nitpick-y of comments—feel free to ignore.
For one, it looked like conda-forge was mostly conda-forge so I tried to add the ` but I'm not sure I got everything 👀

docs/developers/packaging.md Outdated Show resolved Hide resolved
docs/developers/packaging.md Outdated Show resolved Hide resolved
docs/developers/packaging.md Outdated Show resolved Hide resolved
docs/developers/packaging.md Outdated Show resolved Hide resolved
docs/developers/packaging.md Outdated Show resolved Hide resolved
docs/developers/release.md Outdated Show resolved Hide resolved
docs/developers/release.md Outdated Show resolved Hide resolved
docs/developers/release.md Outdated Show resolved Hide resolved
docs/developers/release.md Outdated Show resolved Hide resolved
docs/developers/release.md Outdated Show resolved Hide resolved
Co-authored-by: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
@jaimergp
Copy link
Contributor Author

Thank you @psobolewskiPhD!

Copy link
Contributor

@Czaki Czaki left a comment

Choose a reason for hiding this comment

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

Please add version substitution

jaimergp and others added 2 commits February 2, 2023 10:03
Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
docs/developers/packaging.md Outdated Show resolved Hide resolved
@psobolewskiPhD
Copy link
Member

As far as I'm concerned this is good to go now, @Czaki any last comments?

docs/developers/packaging.md Outdated Show resolved Hide resolved
@jaimergp
Copy link
Contributor Author

Anything else needed, team?

Copy link
Contributor

@Czaki Czaki left a comment

Choose a reason for hiding this comment

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

If you think that manually updating yaml file is ok, then it should be added to the list of things need to be done before release. Next to Ensure conda-recipe/meta.yaml... line

@@ -113,10 +118,10 @@ specs: # specs for the 'base' environment
- mamba # we add these to manage different napari versions
- pip # we add these to manage different napari versions
extra_envs:
napari-0.4.16: # this is the environment that will actually contain the napari packages
napari-0.4.17: # this is the environment that will actually contain the napari packages
Copy link
Contributor

Choose a reason for hiding this comment

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

could we generate this yaml file using template tags to ensure that it will be kept up to date without manual interventions?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unfortunately this is not supported in MyST. See warnings.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Instead I added the term "hypothetical" to make clear we are only providing an example that is not meant to be up to date with the current version. Let me know what you think @Czaki

@jaimergp jaimergp requested a review from Czaki May 2, 2023 09:37
@psobolewskiPhD psobolewskiPhD added ready to merge content Ideas for new or improved content labels May 14, 2023
@jaimergp
Copy link
Contributor Author

Is this good to go? :D

@psobolewskiPhD psobolewskiPhD merged commit 550ad7a into napari:main May 17, 2023
@psobolewskiPhD psobolewskiPhD added this to the 0.5.0 milestone Jun 22, 2023
@Czaki Czaki modified the milestones: 0.5.0, 0.4.18 Jun 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Ideas for new or improved content documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document conda-forge release process in the release docs
4 participants