Skip to content

Commit

Permalink
doc: describe anaconda release process (#111)
Browse files Browse the repository at this point in the history
* DOCS: anaconda-release

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

* Corrected links

Co-authored-by: Paul Horton <phorton@sonatype.com>
  • Loading branch information
jkowalleck and madpah authored Jan 12, 2022
1 parent eca9cc9 commit f01be8a
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![shield_gh-workflow-test]][link_gh-workflow-test]
[![shield_pypi-version]][link_pypi]
[![shield_conda-forge-version]][link_conda-forge]
[![shield_license]][license_file]
[![shield_website]][link_website]
[![shield_slack]][link_slack]
Expand Down Expand Up @@ -52,14 +53,16 @@ See the [LICENSE][license_file] file for the full license.
[contributing_file]: https://github.com/CycloneDX/cyclonedx-python-lib/blob/master/CONTRIBUTING.md

[shield_gh-workflow-test]: https://img.shields.io/github/workflow/status/CycloneDX/cyclonedx-python-lib/Python%20CI/main?logo=GitHub&logoColor=white "build"
[shield_pypi-version]: https://img.shields.io/pypi/v/cyclonedx-python-lib?logo=Python&logoColor=white&label=PyPI "PyPI"
[shield_pypi-version]: https://img.shields.io/pypi/v/cyclonedx-python-lib?logo=pypi&logoColor=white&label=PyPI "PyPI"
[shield_conda-forge-version]: https://img.shields.io/conda/vn/conda-forge/cyclonedx-python-lib?logo=anaconda&logoColor=white&label=conda-forge "conda-forge"
[shield_license]: https://img.shields.io/github/license/CycloneDX/cyclonedx-python-lib "license"
[shield_website]: https://img.shields.io/badge/https://-cyclonedx.org-blue.svg "homepage"
[shield_slack]: https://img.shields.io/badge/slack-join-blue?logo=Slack&logoColor=white "slack join"
[shield_groups]: https://img.shields.io/badge/discussion-groups.io-blue.svg "groups discussion"
[shield_twitter-follow]: https://img.shields.io/badge/Twitter-follow-blue?logo=Twitter&logoColor=white "twitter follow"
[link_gh-workflow-test]: https://github.com/CycloneDX/cyclonedx-python-lib/actions/workflows/poetry.yml?query=branch%3Amain
[link_pypi]: https://pypi.org/project/cyclonedx-python-lib/
[link_conda-forge]: https://anaconda.org/conda-forge/cyclonedx-python-lib
[link_website]: https://cyclonedx.org/
[link_slack]: https://cyclonedx.org/slack/invite
[link_discussion]: https://groups.io/g/CycloneDX
Expand Down
7 changes: 6 additions & 1 deletion docs/install.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
Installation
============

Install from pypi.org as you would any other Python module using your preferred package manager:
Install from `pypi.org`_ as you would any other Python module using your preferred package manager:

.. code-block:: bash
pip install cyclonedx-python-lib
*CycloneDX-python-lib* is also available from `conda-forge`_.

.. _pypi.org: https://pypi.org/project/cyclonedx-python-lib/
.. _conda-forge: https://anaconda.org/conda-forge/cyclonedx-python-lib
35 changes: 35 additions & 0 deletions docs/processes/release/conda-forge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Coda-forge releases

Releases of
[_CycloneDX-python-lib_ for Anaconda][CDXlib-conda-forge]
are managed in a [seperate conda-forge feedstock-repository][CDXlib-conda-forge-feedstock-repo]
as [anounced][first-conda-forge-release]
by [@bollwyvl].

## Current build status

<table><tr><td>All platforms:</td>
<td>
<a href="https://dev.azure.com/conda-forge/feedstock-builds/_build/latest?definitionId=14348&branchName=master">
<img src="https://dev.azure.com/conda-forge/feedstock-builds/_apis/build/status/cyclonedx-python-lib-feedstock?branchName=master">
</a>
</td>
</tr>
</table>

## Current release info

| Name | Downloads | Version | Platforms |
| --- | --- | --- | --- |
| [![Conda Recipe](https://img.shields.io/badge/recipe-cyclonedx--python--lib-green.svg)](https://anaconda.org/conda-forge/cyclonedx-python-lib) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/cyclonedx-python-lib.svg)](https://anaconda.org/conda-forge/cyclonedx-python-lib) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/cyclonedx-python-lib.svg)](https://anaconda.org/conda-forge/cyclonedx-python-lib) | [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/cyclonedx-python-lib.svg)](https://anaconda.org/conda-forge/cyclonedx-python-lib) |

## Licensing

The [_CycloneDX-python-lib_ conda-forge feedstock repository][CDXlib-conda-forge-feedstock-repo] is or may be licensed under a differrent form than the _CycloneDX-python-lib_ project itself.
The License of _CycloneDX-python-lib_ stayes [as stated in it's repository][license_file].

[CDXlib-conda-forge]: https://anaconda.org/conda-forge/cyclonedx-python-lib
[CDXlib-conda-forge-feedstock-repo]: https://github.com/conda-forge/cyclonedx-python-lib-feedstock
[@bollwyvl]: https://github.com/bollwyvl
[first-conda-forge-release]: https://github.com/CycloneDX/cyclonedx-python-lib/issues/44#issuecomment-989912153
[license_file]: https://github.com/CycloneDX/cyclonedx-python-lib/blob/master/LICENSE

0 comments on commit f01be8a

Please sign in to comment.