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.

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

Add extra section in 'The recipe meta.yaml' section. #1767

Closed
wants to merge 4 commits into from
Closed

Add extra section in 'The recipe meta.yaml' section. #1767

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5a92c85
Add an extra section explaining how to become a recipe maintainer
ssurbhi560 Jun 3, 2022
069773d
fix grammatical errors
ssurbhi560 Jun 6, 2022
67a800a
Merge branch 'main' into add-extra-section-in-recipe-meta-yml-section
ssurbhi560 Jun 6, 2022
ef2ab81
Add feedstock-name directive to extra section
ssurbhi560 Jun 10, 2022
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
38 changes: 33 additions & 5 deletions src/maintainer/adding_pkgs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,7 @@ Contributing packages
*********************


To submit a package to the ``conda-forge`` channel, add its ``recipe`` and licence to the ``staged-recipes`` repository and create a pull request. Once the pull request is merged, the package becomes available
on the ``conda-forge`` channel. Note that contributing a package makes you the ``maintainer`` of that package.

A maintainer is responsible for maintaining the feedstock repository and packages as well as their future versions and has push access to the feedstock repositories of only the packages it maintains.
You can learn more about the roles of a maintainer `here. <https://conda-forge.org/docs/maintainer/adding_pkgs.html#maintainer-role>`__
To submit a package to the ``conda-forge`` channel, add its ``recipe`` and licence to the ``staged-recipes`` repository and create a pull request. Once the pull request is merged, the package becomes available on the ``conda-forge`` channel.

The sections below provide detailed instructions on contributing packages to conda-forge.

Expand Down Expand Up @@ -760,6 +756,38 @@ For some languages, the community provides tools which can automate this process
.. note::

The correct and automated packaging of dependency licenses is an ongoing discussion. Please feel free to add your thoughs to `this <https://github.com/conda-forge/conda-forge.github.io/issues/1052>`__ discussion.

Extra
-----

.. _recipe_maintainer:

Recipe Maintainer
..................
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe this should be a series of ^^^^^^^^ instead.

Copy link
Contributor Author

@ssurbhi560 ssurbhi560 Jun 6, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

That's right, @kathatherine, it should be as you suggested; I also read it here. But when I change it from .... to ^^^, it doesn't work, and the heading doesn't show up under this section. It seems weird, but I guess (not sure though) it is because we are using this sequence
[
=== ---> for Sections
---- ---> for Sub-sections
...... ---> for subsubsections
^^^ ---> for section under subsubsection
and so on.
]
in this file, and this might be reason why this doesn't work.

Copy link
Contributor

Choose a reason for hiding this comment

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

Gotcha. Well, if it works in the output, we'll keep it!


A maintainer is an individual who is responsible for maintaining and updating one or more feedstock repositories and packages, as well as their future versions. They have push access to the feedstock repositories of only the packages they maintain and can merge pull requests into them.
Contributing a recipe for package makes you the ``maintainer`` of that package automatically.
See `Maintainers Role <https://conda-forge.org/docs/maintainer/adding_pkgs.html#maintainer-role>`__ and `Maintaining Packages <https://conda-forge.org/docs/maintainer/updating_pkgs.html#maintaining-packages>`__ to learn more about the things that maintainers do.

If you wish to be a maintainer of a certain package, you should contact current maintainers and open an issue in that package's feedstock with the following command:

``@conda-forge-admin, please add user @username``

where username is the GitHub username of the new maintainer to be added. Please refer to `Becoming a maintainer <https://conda-forge.org/docs/orga/guidelines.html#becoming-a-maintainer>`__ and `Updating the maintainer list <https://conda-forge.org/docs/maintainer/updating_pkgs.html#updating-the-maintainer-list>`__ for detailed instructions.

.. _feedstock_name:

Feedstock name
..............

If you would want to name the feedstock different from the package name in the staged-recipes, you can use the ``feedstock-name`` directive in the recipe of that package, like this:

.. code-block:: yaml

extra:
feedstock-name: <name>

Here, ``<name>`` is the name you would want for the feedstock.

Miscellaneous
=============
Expand Down