Skip to content

Commit

Permalink
Update release documentation; Remove Travis CI references
Browse files Browse the repository at this point in the history
  • Loading branch information
sjohannes committed Dec 19, 2020
1 parent baea575 commit d0d2942
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 8 deletions.
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,6 @@ dist:
./tools/dist.sh
rm -rf dist/copy

# See .travis.yml for details on how tests are ran by Travis CI
check-doc: clean
$(MAKE) -C doc html

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Exaile
======

[![Build Status](https://travis-ci.org/exaile/exaile.svg?branch=master)](https://travis-ci.org/exaile/exaile)
[![Build Status](https://github.com/exaile/exaile/workflows/Exaile%20CI/badge.svg)](https://github.com/exaile/exaile/actions?query=workflow%3A%22Exaile+CI%22+branch%3Amaster)
[![Translate with Weblate](https://hosted.weblate.org/widgets/exaile/-/svg-badge.svg)](https://hosted.weblate.org/engage/exaile/)

Exaile is a music player with a simple interface and powerful
Expand Down
19 changes: 13 additions & 6 deletions doc/dev/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Step 3: Tag the release locally
-------------------------------

Make sure you have the correct thing checked out in your git tree, and then
tag the release.
tag the release.

.. code-block:: sh
Expand Down Expand Up @@ -120,10 +120,17 @@ then re-tag and re-push.
Step 6: Release the release
---------------------------

Once the tag is in GitHub, Travis CI will build a Linux dist and AppVeyor
will build a Windows installer and upload it to GitHub releases as a draft.
Once the assets are uploaded, you can edit the draft release and paste in
your release notes, then click 'Publish Release'.
Once the tag is in the GitHub repository, GitHub Actions will build a source
tarball and AppVeyor will build a Windows installer.
They will create a draft release on GitHub containing those files.
Edit the draft, paste in your release notes, then click 'Publish Release'.

Ideally, the release notes should include a checksum for each release artifact.
This can be created (for the format we usually use) with

.. code-block:: sh
sha256sum --tag FILENAME
Final steps
Expand All @@ -143,7 +150,7 @@ After a release, we should:

- Update versions in ``_config.yml``
- Add a new post to ``_posts``

* Send email to exaile-dev and exaile-users mailing lists with the release notes

* Update the channel topic on IRC (``/msg ChanServ topic #exaile ...``)

0 comments on commit d0d2942

Please sign in to comment.