Skip to content

Commit

Permalink
Adjusting wrong release name to "anthenea" (#479).
Browse files Browse the repository at this point in the history
Related-Issue: #479
Closes: #479
Projected-Results-Impact: none
  • Loading branch information
holtgrewe committed May 6, 2022
1 parent a55a005 commit 385d3b2
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 9 deletions.
6 changes: 4 additions & 2 deletions HISTORY.rst
Expand Up @@ -18,6 +18,7 @@ End-User Summary
This has not been implemented so far.
- Fixing paths in "Variant Ingest" documentation (#472).
- Small extension of "Resolution proposal" template (#472).
- Adjusting wrong release name to "anthenea" (#479).

Full Change List
================
Expand All @@ -31,6 +32,7 @@ Full Change List
This has not been implemented so far.
- Fixing paths in "Variant Ingest" documentation (#472).
- Small extension of "Resolution proposal" template (#472).
- Adjusting wrong release name to "anthenea" (#479).

------
v1.2.0
Expand Down Expand Up @@ -104,7 +106,7 @@ Full Change List
v1.1.1
------

This is the first release candidate of the VarFish "Athenea" release (v1).
This is the first release candidate of the VarFish "Anthenea" release (v1).
Importantly, the first stable release for v1 will be v1.2.0 (see `Release Cycle Documentation <https://varfish-server.readthedocs.io/en/latest/release_cycle.html>`__ for a full explanation of version semantics).

This release adds some more indices so the migrations might take some more time.
Expand Down Expand Up @@ -132,7 +134,7 @@ Full Change List
v1.1.0
------

This is the first release candidate of the VarFish "Athenea" release (v1).
This is the first release candidate of the VarFish "Anthenea" release (v1).
Importantly, the first stable release for v1 will be v1.2.0 (see `Release Cycle Documentation <https://varfish-server.readthedocs.io/en/latest/release_cycle.html>`__ for a full explanation of version semantics).

Breaking changes, see below.
Expand Down
2 changes: 1 addition & 1 deletion docs_manual/admin_install.rst
Expand Up @@ -84,7 +84,7 @@ We currently only provide prebuilt databases for either GRCh37 or GRCh38.

.. code-block:: bash
$ wget --no-check-certificate https://file-public.cubi.bihealth.org/transient/varfish/athenea/varfish-site-data-v1-20210728-grch37.tar.gz{,.sha256}
$ wget --no-check-certificate https://file-public.cubi.bihealth.org/transient/varfish/anthenea/varfish-site-data-v1-20210728-grch37.tar.gz{,.sha256}
$ sha256sum --check varfish-site-data-v1-20210728-grch37.tar.gz.sha256
$ tar xf varfish-site-data-v1-20210728-grch37.tar.gz
$ ls volumes
Expand Down
2 changes: 1 addition & 1 deletion docs_manual/admin_upgrade.rst
Expand Up @@ -14,7 +14,7 @@ The data release has a problem with the GRCh37 extra annotations.
If you can then use the updated site data ``20210728b`` release.
If you already have an instance with ``20210728`` background data then you can use the following data file.

- `varfish-server-background-db-20210728-grch37-patch-20210728b.tar.gz <https://file-public.cubi.bihealth.org/transient/varfish/athenea/varfish-server-background-db-20210728-grch37-patch-20210728b.tar.gz>`__
- `varfish-server-background-db-20210728-grch37-patch-20210728b.tar.gz <https://file-public.cubi.bihealth.org/transient/varfish/anthenea/varfish-server-background-db-20210728-grch37-patch-20210728b.tar.gz>`__

Download and extract the file and mount it as ``/data`` inside the ``varfish-web`` container.
You can then apply the patch to your database with the following command.
Expand Down
2 changes: 1 addition & 1 deletion docs_manual/developer_data_builds.rst
Expand Up @@ -67,7 +67,7 @@ Download static data
::

$ cd /plenty/space
$ wget https://file-public.bihealth.org/transient/varfish/athenea/varfish-server-background-db-20201006.tar.gz{,.sha256}
$ wget https://file-public.bihealth.org/transient/varfish/anthenea/varfish-server-background-db-20201006.tar.gz{,.sha256}
$ sha256sum -c varfish-server-background-db-20201006.tar.gz.sha256
$ tar xzvf varfish-server-background-db-20201006.tar.gz

Expand Down
8 changes: 4 additions & 4 deletions docs_manual/release_cycle.rst
Expand Up @@ -8,12 +8,12 @@ This section documents the versioning and branching model of VarFish.
Generally, we follow the idea of release cycles as `also employed by Ceph <https://docs.ceph.com/en/latest/releases/general/>`__.

There is a new stable release every year, targeting the month of April.
Each stable release receives a name (e.g., "Athenea") and a major release number, (e.g., 1 as "A" is the first letter of the alphabet).
Each stable release receives a name (e.g., "Anthenea") and a major release number, (e.g., 1 as "A" is the first letter of the alphabet).

Releases are named after starfish species.

Version numbers have three components, ``x.y.z``.
``x`` identifies the release cycle (e.g., ``1`` for ``Athenea``).
``x`` identifies the release cycle (e.g., ``1`` for ``Anthenea``).
``y`` identifies the release type:

- ``x.0.z`` - development versions (the bleeding edge)
Expand Down Expand Up @@ -54,8 +54,8 @@ Release Names
- Species
* - 2022
- 1.y.z
- Athenea
- *Athenea aspera*
- Anthenea
- *Anthenea aspera*
* - 2023
- 2.y.z
- Bollonaster
Expand Down

0 comments on commit 385d3b2

Please sign in to comment.