Skip to content

Commit b4f5af9

Browse files
authored
Merge pull request #251 from technosf/development
Beta ready
2 parents 6722e86 + f0a7b8d commit b4f5af9

File tree

7 files changed

+113
-110
lines changed

7 files changed

+113
-110
lines changed

DEVELOP.md

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ Discover and Listen to your favourite internet radio stations, and add improve t
1414
- [VSCode](#vscode)
1515
- [Bug Introduction Deduction](#bug-introduction-deduction)
1616
- [Release Process](#release-process)
17-
- [Beta Releases](#beta-releases)
18-
- [Production Releases](#production-releases)
1917

2018
## Overview
2119

@@ -221,22 +219,4 @@ After checking out the required version, build and run the app as described abov
221219

222220
## Release Process
223221

224-
Releasing _Tuner_ comprises cutting a release of the code in [tuner github](https://github.com/tuner-app/tuner) and then updating the [flathub repo](https://github.com/flathub/com.github.louis77.tuner) which will automatically have the flatpak generated and rolled to Flathub for distribution.
225-
226-
### Beta Releases
227-
228-
Beta releases should be tagged from the Tuner _development_ branch in with a version number format of _v1.\*.\*-beta.\*_
229-
230-
Once a beta release has been tagged, the Flathub _beta_ branch can be updated via a pull request with the _beta_ tag going into the manifest _.json_, and any patches and documentation updated as needed. The pull request will trigger a flathub build, but will not merge the pull request - pull requests should be merged only if they result in a successful build.
231-
232-
Once the beta is successfully built by flathub it will be available for installation and testing within the user community.
233-
234-
Once a beta roll is deamed a success its pull request can be merged, and a production release can be rolled.
235-
236-
### Production Releases
237-
238-
Production releases are generated from _development_ pull requests into _main_. The updated _main_ branch should be tagged with a version number format of _v1.\*.\*_
239-
240-
Once a release has been tagged, the [flathub repo](https://github.com/flathub/com.github.louis77.tuner) _main_ branch can be updated with the _release_ tag going into the manifest _.json_, and any patches and documentation updated as needed. Updates from the _main_ branch should be copied in from a direct _pull request_ of the _main_ branch. The _main_ branch **should not** come from a merge _beta_ branch to avoid triggering subsequent builds in _beta_ .
241-
242-
Once the main production release is built by flathub it will be available for installation and automatically distributed to user community.
222+
Cutting a releasing **Tuner** on [github](https://github.com/tuner-labs/tuner) and packaging and pushing out a new **Flathub** distribution are covered in the [release doc](RELEASE.md)

I18N.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Internationalization
22

3-
**Tuner** uses [Gnome *i18n*](https://developer.gnome.org/documentation/guidelines/localization.html) for internationalization. This system specifies target files and extracts identified strings for translation in the source, the target languages, and during the build process compiles translated strings into package which. The appropriate translated strings are then used by the host system when running **Tuner**.
3+
**Tuner** uses [Gnome *i18n*](https://developer.gnome.org/documentation/guidelines/localization.html) for internationalization. This system and library specifies source files (*POTFILES*) from which to extract identified strings for translation (the *.pot* file) and the target languages (*LINGUAS*). During the build process translated strings (*.po* files) are package and the included library uses the appropriate translated strings are then used by the host system when running **Tuner**.
44

5-
Translations are managed and applied by [Weblate](https://hosted.weblate.org/projects/tuner/) as two different components:
5+
Translations are creted, managed and applied via [Weblate](https://hosted.weblate.org/projects/tuner/) as two different components:
66

77
* The application [UI](https://hosted.weblate.org/projects/tuner/tuner-ui/)
88
* The flatpak [Desktop](https://hosted.weblate.org/projects/tuner/tuner-desktop/) metadata
@@ -39,4 +39,4 @@ This:
3939
* Builds the **main** *.pot* file that relates to the UI
4040
* Builds the **extra** *.pot* file that relates to the Desktop metadata
4141

42-
Updates to the *.pot*, *LINGUAS* and *POTFILES* files *pushed* to the development branch will be picked up by Weblate and can be worked on on the Weblate **Tuner** page.
42+
Updates to the *.pot*, *LINGUAS* and *POTFILES* files *pushed* to the development branch will be picked up by Weblate and can be worked on the Weblate **Tuner** page. Weblate then generates the *.po* translation files and opens a github pull request to have them included in **Tuner**

PACKAGING.md

Lines changed: 10 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
# Packaging instructions for various platform
1+
# Packaging Tuner for Various Platforms
22

3-
## Local Build
3+
The **flathub** packaging for **Tuner** is documented in <RELEASE.md>
44

5-
Building Tuner localy is described in the [development doc](DEVELOP.md).
5+
Other packaged versions of Tuner maybe available, but are maintained outside of Tuner itself; Versions may be out of date.
66

7-
## Packages for other platforms and distos
7+
If you are packaging **Tuner** please contribute to this page.
88

9-
Other packed versions of Tuner are available, but are maintained outside of Tuner itself: Versions may be out of date.
10-
11-
### Arch Linux / AUR
9+
## Arch Linux / AUR
1210

1311
Arch-based GNU/Linux users can find `Tuner` under the name [tuner-git](https://aur.archlinux.org/packages/tuner-git/) in the **AUR**:
1412

@@ -18,15 +16,17 @@ yay -S tuner-git
1816

1917
Thanks to [@btd1377](https://github.com/btd1337) for supporting Tuner on Arch Linux!
2018

21-
### MX Linux
19+
## MX Linux
2220

2321
MX Linux users can find `Tuner` by using the MX Package Installer (currently under the MX Test Repo tab for MX-19 and the Stable Repo for MX-21)
2422

2523
Thanks to SwampRabbit for packaging Tuner for MX Linux!
2624

27-
### Pacstall
25+
## Pacstall
26+
27+
Pacstall is a totally new package manager for Ubuntu that provides an AUR-like community-driven repo for package builds.
2828

29-
Pacstall is a totally new package manager for Ubuntu that provides an AUR-like community-driven repo for package builds. If you already use `pacstall` you can install Tuner:
29+
If you already use `pacstall` you can install Tuner:
3030

3131
```bash
3232
pacstall -I tuner
@@ -35,63 +35,3 @@ pacstall -I tuner
3535
If you have Ubuntu and want a clean build of Tuner on your system, consider using `pacstall` instead of Flatpak if you don't feat beta software. Get `pacstall` here:
3636

3737
<https://pacstall.dev>
38-
39-
## General
40-
41-
### Desktop Menu
42-
43-
The desktop file must be validated using this command:
44-
45-
```bash
46-
desktop-file-validate [name-of-desktop-file]
47-
```
48-
49-
### AppData
50-
51-
The AppData.xml must be validated using this command:
52-
53-
```bash
54-
flatpak run org.freedesktop.appstream-glib validate [path-to-xml]
55-
56-
```
57-
58-
### Test different languages
59-
60-
```bash
61-
LANGUAGE=de_DE ./com.github.louis77.tuner
62-
63-
```
64-
65-
## Flatpak
66-
67-
The flathub build manifest can be found here:
68-
<https://github.com/louis77/flathub/tree/com.github.louis77.tuner>
69-
70-
## Pacstall
71-
72-
Tuner is in the pacstall repo with the lastest release (1.3.1):
73-
<https://github.com/louis77/pacstall-programs>
74-
75-
## Dev Tricks
76-
77-
### See Debug Log
78-
79-
<https://docs.elementary.io/develop/writing-apps/logging>
80-
81-
```bash
82-
G_MESSAGES_DEBUG=all ./com.github.louis77.tuner
83-
```
84-
85-
### Available elementary Icons
86-
87-
Use LookBook app.
88-
89-
### Manually compile schemas
90-
91-
```bash
92-
sudo /usr/bin/glib-compile-schemas /usr/share/glib-2.0/schemas/
93-
```
94-
95-
## Release Checklist
96-
97-
- [ ] Create Release Tag in AppData

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,24 @@ Minimalist radio station player - **Tuner** Version 2
1414

1515
## Features
1616

17-
- Play ever changing stations found in [radio-browser.info](https://www.radio-browser.info/) radio station index
18-
- See the top selections of stations (random, top, trending) from the index
19-
- See the different station content genres and subgeneres from the index
17+
- Explore ever changing radio stations indexed in [radio-browser.info](https://www.radio-browser.info/)
18+
- See the top selections of listened to and saved stations from the index
19+
- Find different station content genres and subgeneres from the index
2020
- Jukebox - Play a new random station every ten minutes
2121
- Save your favourite stations
22-
- Search for stations and content
22+
- Search for stations and content by keyword
2323
- Save your favorite station searches
2424
- Export your favorite stations to _m3u_ playlists
2525
- DBus integration to pause/resume playing and show station info in Wingpanel
2626
- Updates station click count at station index on station play
2727
- Updates station vote count at station index when you star a station
2828

29+
### Internationalization & Translation
30+
31+
**Tuner** is Internationalized, and is available in various languges. Translations are hosted on [Weblate](https://hosted.weblate.org/engage/tuner/). Please help by [translating Tuner into your language or fix any translation issues](I18N.md) you find.
32+
33+
Thanks to the Weblate team for generously hosting **Tuner** for free!
34+
2935
### Recent Updates
3036

3137
_December 2025_ all things **Tuner** have become a _Github Organization_ called [**tuner_labs**](https://github.com/tuner-labs) to ensure **Tuner** continues to be available and we invite you to participate in keeping it a great source of music discovery and Internet Radio player.
@@ -36,22 +42,17 @@ _January 2025_ Version 2 released with major new features and performance improv
3642

3743
**Tuner** is primarily [developed](DEVELOP.md) and distributed as a Flatpak on [Flathub](https://flathub.org/apps/details/com.github.louis77.tuner).
3844

39-
It can also be built and [distributed via other platforms and distos](PACKAGING.md). Make **Tuner** work on your favorite Disto/Package.
40-
41-
## Translation
45+
It can also be built and [distributed via other platforms and distos](PACKAGING.md).
46+
Please help make **Tuner** work on your favorite Disto/Package.
4247

43-
**Tuner** is Internationalized, and is available in various languges. Translations are hosted on [Weblate](https://hosted.weblate.org/engage/tuner/). Please help by [translating Tuner into your language or fix any translation issues](I18N.md) you find.
48+
## Status and Support
4449

45-
Thanks to the Weblate team for generously hosting **Tuner** for free!
50+
Join in or start [discussion about tuner](https://github.com/orgs/tuner-labs/discussions)... Feature request, observations and Issues can be documented with tickets on [Github](https://github.com/tuner-labs/tuner/issues)
4651

47-
## Build, Maintance and Development of Tuner
52+
### Build, Maintance and Development of Tuner
4853

4954
Building, developing and maintianing **Tuner** is detailed seperately and in detail in the [DEVELOP](DEVELOP.md) markdown.
5055

51-
## Status and Support
52-
53-
Feature request, observations and Issues can be documented with tickets on [Github](https://github.com/tuner-labs/tuner/issues)
54-
5556
### Known Issues
5657

5758
#### If AAC/AAC+ streams don't play (found on Elementary OS 6) install the following dependency

RELEASE.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Tuner Release Process
2+
3+
## Local Build
4+
5+
Building Tuner locally is described in the [development doc](DEVELOP.md).
6+
7+
## Flathub
8+
9+
The flathub packaging for **Tuner** is maintained in its own github repo:
10+
<https://github.com/tuner-labs/tuner-flathub> on branch *com.github.louis77.tuner*
11+
12+
### Desktop Menu
13+
14+
The desktop file must be validated using this command:
15+
16+
```bash
17+
desktop-file-validate com.github.louis77.tuner.desktop
18+
```
19+
20+
### AppData
21+
22+
The AppData.xml must be validated using this command:
23+
24+
```bash
25+
flatpak run org.freedesktop.appstream-glib validate [path-to-xml]
26+
27+
```
28+
29+
### Test different languages
30+
31+
```bash
32+
LANGUAGE=de_DE ./com.github.louis77.tuner
33+
```
34+
35+
## Flatpak
36+
37+
Releasing *Tuner* comprises cutting a release of the code in [tuner github](https://github.com/tuner-app/tuner) and then updating the [flathub repo](https://github.com/flathub/com.github.louis77.tuner) which will automatically have the flatpak generated and rolled to Flathub for distribution.
38+
39+
## Flathub Builds
40+
41+
**flathub** builds can be monitored at <https://flathub.org/en/builds>
42+
43+
### Beta Releases
44+
45+
Beta releases should be tagged from [github](https://github.com/tuner-labs/tuner/releases/new) using the Tuner *development* branch - the *meson* buildfile should have the same version number - the beta format is *v2\*.\*-beta.\**
46+
47+
Once a beta release has been tagged, the Flathub *beta* branch can be updated via a pull request with the *beta* tag going into the manifest *.json*, and any patches and documentation updated as needed. The pull request will trigger a flathub build, but will not merge the pull request - pull requests should be merged only if they result in a successful build.
48+
49+
Once the beta is successfully built by flathub it will be available for installation and testing within the user community.
50+
51+
Once a beta roll is deemed a success its pull request can be merged, and a production release can be rolled.
52+
53+
### Production Releases
54+
55+
Production releases are generated from *development* pull requests into *main*. The updated *main* branch should be tagged with a version number format of *v2.\*.\**
56+
57+
Once a release has been tagged, the [flathub repo](https://github.com/flathub/com.github.louis77.tuner) *main* branch can be updated with the *release* tag going into the manifest *.json*, and any patches and documentation updated as needed. Updates from the *main* branch should be copied in from a direct *pull request* of the *main* branch. The *main* branch **should not** come from a merge *beta* branch to avoid triggering subsequent builds in *beta*.
58+
59+
Once the main production release is built by flathub it will be available for installation and automatically distributed to user community.
60+
61+
The flathub build manifest can be found here:
62+
<https://github.com/louis77/flathub/tree/com.github.louis77.tuner>
63+
64+
### Dev Tricks
65+
66+
#### See Debug Log
67+
68+
<https://docs.elementary.io/develop/writing-apps/logging>
69+
70+
```bash
71+
G_MESSAGES_DEBUG=all ./com.github.louis77.tuner
72+
```
73+
74+
### Manually compile schemas
75+
76+
```bash
77+
sudo /usr/bin/glib-compile-schemas /usr/share/glib-2.0/schemas/
78+
```
79+
80+
### Release Checklist
81+
82+
- [ ] Create Release Tag in AppData

data/com.github.louis77.tuner.appdata.xml.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102
<li>Bumped libgee to 0.20.8</li>
103103
<li>Sharpened some wording, fixed typos</li>
104104
<li>Updated translated strings and incorporated fresh translations</li>
105-
<li>i18n - Added trad Chinese, Romaian, Tamil and Lating American Spanish</li>
105+
<li>i18n - Added trad Chinese, Romaian, Tamil and Latin American Spanish</li>
106106
</ul>
107107
</description>
108108
</release>

meson.build

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
project (
33
'com.github.louis77.tuner',
44
'vala', 'c',
5-
version: '2.0.2-BETA',
5+
version: '2.0.1-beta.1',
66
meson_version: '>= 0.60.0',
77
)
88

0 commit comments

Comments
 (0)