Skip to content

Commit

Permalink
Remove snap package entirely
Browse files Browse the repository at this point in the history
* broken and really not worth the effort fixing

[skip ci]
  • Loading branch information
vilhelmprytz committed Apr 24, 2022
1 parent b27bf20 commit c057239
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 75 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/---bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ assignees: ""

### Environment

- Installation type: <!-- snap/pip -->
- Installation type: <!-- homebrew/pip -->
- Python version: <!-- Example: 3.7.13 -->
- Wilfred version: <!-- Example: 1.0, 2.0, …, master -->

Expand Down
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# Wilfred

[![Build Status](https://travis-ci.com/wilfred-dev/wilfred.svg?branch=master)](https://travis-ci.com/wilfred-dev/wilfred)
[![.github/workflows/check.yml](https://github.com/wilfred-dev/wilfred/actions/workflows/check.yml/badge.svg)](https://github.com/wilfred-dev/wilfred/actions/workflows/check.yml)
[![Python Versions](https://img.shields.io/pypi/pyversions/wilfred)](https://pypi.org/project/wilfred)
[![pypi](https://img.shields.io/pypi/v/wilfred)](https://pypi.org/project/wilfred)
[![wilfred](https://snapcraft.io//wilfred/badge.svg)](https://snapcraft.io/wilfred)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/wilfred-dev/wilfred.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/wilfred-dev/wilfred/context:python)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/wilfred-dev/wilfred.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/wilfred-dev/wilfred/alerts/)
[![Downloads](https://pepy.tech/badge/wilfred)](https://pepy.tech/project/wilfred)
Expand Down Expand Up @@ -60,8 +59,6 @@ Wilfred can also be installed using `pip`. You need to use **Python 3.7** or new
pip install wilfred --upgrade
```

A [snap](https://snapcraft.io/wilfred) package is also in the works but is currently not considered stable.

Once you got Wilfred installed, run `wilfred setup` to set a path for Wilfred to use to store server files.

![Creating a server in Wilfred](https://raw.githubusercontent.com/wilfred-dev/wilfred/master/docs/quickstart.gif)
Expand Down
8 changes: 3 additions & 5 deletions docs/source/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,17 @@ In this way, you can develop and see your changes instantly.
Publishing a release
--------------------

Update the version in `wilfred/version.py`, `snap/snapcraft.yml` and `docs/source/conf.py` accordingly.
Update the version in `wilfred/version.py` and `docs/source/conf.py` accordingly.

Set the version name and release status of this release in `CHANGELOG.md` to `released on YYYY-MM-DD`.

Commit the changes.

Tag the release on GitHub. Include all the changes from `CHANGELOG.md` in the release notes (you can use a previous release as reference).

Travis should automatically build and release the `PyPI package <https://pypi.org/project/wilfred/>`__, and snapcraft should also build and release the snap package automatically.
GitHub Actions should automatically build and release the `PyPI package <https://pypi.org/project/wilfred/>`__.

After the `snap build <https://build.snapcraft.io/user/wilfred-dev/wilfred>`__ has finished, go to the `Snap <https://snapcraft.io/wilfred>`__ listing and push the `edge` channel to `stable` or `beta` depending on the type of release.

Revert the changes in `wilfred/version.py` and `snap/snapcraft.yml` and commit the changes (should therefore not be included in the release).
Revert the changes in `wilfred/version.py` and commit the changes (should therefore not be included in the release).

Windows
-------
Expand Down
25 changes: 0 additions & 25 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,25 +68,6 @@ You can install using a specific python version, e.g. `3.8`.
python3.8 -m pip install wilfred --upgrade
Snap (experimental)
^^^^^^^^^^^^^^^^^^^

.. warning::
The snap package is not considered stable. You can only install it using the `--devmode` which is not recommended in a production environment. For now, please use the pip package. See issue `#6 <https://github.com/wilfred-dev/wilfred/issues/6>`__ for updates regarding the snap package.

|snapbadge|_

.. |snapbadge| image:: https://snapcraft.io/static/images/badges/en/snap-store-black.svg
.. _snapbadge: https://snapcraft.io/wilfred

Snapcraft is configured to automatically build the latest commit and push it to the `edge` release branch. These releases can be installed using snap. Currently, the same releases pushed to Pip are also pushed to the `beta` branch.

.. code-block:: bash
snap install wilfred --beta --devmode
Again, the ``--beta`` channel and ``--devmode`` should **not** be used in a production environment.

Basic Configuration
-------------------

Expand Down Expand Up @@ -117,12 +98,6 @@ If you installed Wilfred using ``pip``, then you can upgrade by running the same
pip install wilfred --upgrade
If you installed Wilfred using ``snap``, you can use ``refresh`` to download the latest version (snap should automatically update).

.. code-block:: bash
snap refresh wilfred
If you installed Wilfred using ``brew``, you can use Homebrew to upgrade Wilfred as you would do with any formula.

.. code-block:: bash
Expand Down
40 changes: 0 additions & 40 deletions snap/snapcraft.yaml

This file was deleted.

0 comments on commit c057239

Please sign in to comment.