mirror of
https://github.com/YunoHost-Apps/bookwyrm_ynh.git
synced 2024-09-03 18:16:12 +02:00
commit
3d252dba87
9 changed files with 16 additions and 189 deletions
107
.github/workflows/updater.sh
vendored
107
.github/workflows/updater.sh
vendored
|
@ -1,107 +0,0 @@
|
||||||
#!/bin/bash
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# PACKAGE UPDATING HELPER
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
# This script is meant to be run by GitHub Actions
|
|
||||||
# The YunoHost-Apps organisation offers a template Action to run this script periodically
|
|
||||||
# Since each app is different, maintainers can adapt its contents so as to perform
|
|
||||||
# automatic actions when a new upstream release is detected.
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# FETCHING LATEST RELEASE AND ITS ASSETS
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
# Fetching information
|
|
||||||
current_version=$(cat manifest.json | jq -j '.version|split("~")[0]')
|
|
||||||
repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]')
|
|
||||||
# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions)
|
|
||||||
version=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1)
|
|
||||||
assets="https://github.com/bookwyrm-social/bookwyrm/archive/refs/tags/$version.tar.gz"
|
|
||||||
|
|
||||||
# Later down the script, we assume the version has only digits and dots
|
|
||||||
# Sometimes the release name starts with a "v", so let's filter it out.
|
|
||||||
# You may need more tweaks here if the upstream repository has different naming conventions.
|
|
||||||
if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then
|
|
||||||
version=${version:1}
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Setting up the environment variables
|
|
||||||
echo "Current version: $current_version"
|
|
||||||
echo "Latest release from upstream: $version"
|
|
||||||
echo "VERSION=$version" >> $GITHUB_ENV
|
|
||||||
echo "REPO=$repo" >> $GITHUB_ENV
|
|
||||||
# For the time being, let's assume the script will fail
|
|
||||||
echo "PROCEED=false" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
# Proceed only if the retrieved version is greater than the current one
|
|
||||||
if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then
|
|
||||||
echo "::warning ::No new version available"
|
|
||||||
exit 0
|
|
||||||
# Proceed only if a PR for this new version does not already exist
|
|
||||||
elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then
|
|
||||||
echo "::warning ::A branch already exists for this update"
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# UPDATE SOURCE FILES
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
# Let's download source tarball
|
|
||||||
asset_url=$assets
|
|
||||||
|
|
||||||
echo "Handling asset at $asset_url"
|
|
||||||
|
|
||||||
src="app"
|
|
||||||
|
|
||||||
# Create the temporary directory
|
|
||||||
tempdir="$(mktemp -d)"
|
|
||||||
|
|
||||||
# Download sources and calculate checksum
|
|
||||||
filename=${asset_url##*/}
|
|
||||||
curl --silent -4 -L $asset_url -o "$tempdir/$filename"
|
|
||||||
checksum=$(sha256sum "$tempdir/$filename" | head -c 64)
|
|
||||||
|
|
||||||
# Delete temporary directory
|
|
||||||
rm -rf $tempdir
|
|
||||||
|
|
||||||
# Get extension
|
|
||||||
if [[ $filename == *.tar.gz ]]; then
|
|
||||||
extension=tar.gz
|
|
||||||
else
|
|
||||||
extension=${filename##*.}
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Rewrite source file
|
|
||||||
cat <<EOT > conf/$src.src
|
|
||||||
SOURCE_URL=$asset_url
|
|
||||||
SOURCE_SUM=$checksum
|
|
||||||
SOURCE_SUM_PRG=sha256sum
|
|
||||||
SOURCE_FORMAT=$extension
|
|
||||||
SOURCE_IN_SUBDIR=true
|
|
||||||
SOURCE_FILENAME=
|
|
||||||
SOURCE_EXTRACT=true
|
|
||||||
EOT
|
|
||||||
echo "... conf/$src.src updated"
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# SPECIFIC UPDATE STEPS
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
# Any action on the app's source code can be done.
|
|
||||||
# The GitHub Action workflow takes care of committing all changes after this script ends.
|
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# GENERIC FINALIZATION
|
|
||||||
#=================================================
|
|
||||||
|
|
||||||
# Replace new version in manifest
|
|
||||||
echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json
|
|
||||||
|
|
||||||
# No need to update the README, yunohost-bot takes care of it
|
|
||||||
|
|
||||||
# The Action will proceed only if the PROCEED environment variable is set to true
|
|
||||||
echo "PROCEED=true" >> $GITHUB_ENV
|
|
||||||
exit 0
|
|
49
.github/workflows/updater.yml
vendored
49
.github/workflows/updater.yml
vendored
|
@ -1,49 +0,0 @@
|
||||||
# This workflow allows GitHub Actions to automagically update your app whenever a new upstream release is detected.
|
|
||||||
# You need to enable Actions in your repository settings, and fetch this Action from the YunoHost-Apps organization.
|
|
||||||
# This file should be enough by itself, but feel free to tune it to your needs.
|
|
||||||
# It calls updater.sh, which is where you should put the app-specific update steps.
|
|
||||||
name: Check for new upstream releases
|
|
||||||
on:
|
|
||||||
# Allow to manually trigger the workflow
|
|
||||||
workflow_dispatch:
|
|
||||||
# Run it every day at 6:00 UTC
|
|
||||||
schedule:
|
|
||||||
- cron: '0 6 * * *'
|
|
||||||
jobs:
|
|
||||||
updater:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Fetch the source code
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
- name: Run the updater script
|
|
||||||
id: run_updater
|
|
||||||
run: |
|
|
||||||
# Setting up Git user
|
|
||||||
git config --global user.name 'yunohost-bot'
|
|
||||||
git config --global user.email 'yunohost-bot@users.noreply.github.com'
|
|
||||||
# Run the updater script
|
|
||||||
/bin/bash .github/workflows/updater.sh
|
|
||||||
- name: Commit changes
|
|
||||||
id: commit
|
|
||||||
if: ${{ env.PROCEED == 'true' }}
|
|
||||||
run: |
|
|
||||||
git commit -am "Upgrade to v$VERSION"
|
|
||||||
- name: Create Pull Request
|
|
||||||
id: cpr
|
|
||||||
if: ${{ env.PROCEED == 'true' }}
|
|
||||||
uses: peter-evans/create-pull-request@v4
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
commit-message: Update to version ${{ env.VERSION }}
|
|
||||||
committer: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
|
|
||||||
author: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
|
|
||||||
signoff: false
|
|
||||||
base: testing
|
|
||||||
branch: ci-auto-update-v${{ env.VERSION }}
|
|
||||||
delete-branch: true
|
|
||||||
title: 'Upgrade to version ${{ env.VERSION }}'
|
|
||||||
body: |
|
|
||||||
Upgrade to v${{ env.VERSION }}
|
|
||||||
draft: false
|
|
14
README.md
14
README.md
|
@ -19,7 +19,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
||||||
BookWyrm is a social network for tracking your reading, talking about books, writing reviews, and discovering what to read next.
|
BookWyrm is a social network for tracking your reading, talking about books, writing reviews, and discovering what to read next.
|
||||||
|
|
||||||
|
|
||||||
**Shipped version:** 0.5.4~ynh1
|
**Shipped version:** 0.6.0~ynh1
|
||||||
|
|
||||||
**Demo:** https://joinbookwyrm.com/fr/
|
**Demo:** https://joinbookwyrm.com/fr/
|
||||||
|
|
||||||
|
@ -27,18 +27,6 @@ BookWyrm is a social network for tracking your reading, talking about books, wri
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Disclaimers / important information
|
|
||||||
|
|
||||||
This project is still young and isn't, at the moment, very stable, so please proceed with caution when running in production.
|
|
||||||
|
|
||||||
Generate the admin code with ``` sudo -u bookwyrm /var/www/bookwyrm/venv/bin/python3 /var/www/bookwyrm/manage.py admin_code```, and copy the admin code to use when you create your admin account. You can get your code at any time by re-running that command. Here's an example output:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
*******************************************
|
|
||||||
Use this code to create your admin account:
|
|
||||||
c6c35779-af3a-4091-b330-c026610920d6
|
|
||||||
*******************************************
|
|
||||||
```
|
|
||||||
## Documentation and resources
|
## Documentation and resources
|
||||||
|
|
||||||
* Official app website: <https://joinbookwyrm.com/fr/>
|
* Official app website: <https://joinbookwyrm.com/fr/>
|
||||||
|
|
14
README_fr.md
14
README_fr.md
|
@ -19,7 +19,7 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
|
||||||
BookWyrm est un réseau social pour garder la trace de vos lectures, parler de livres, écrire des critiques et découvrir quoi lire ensuite.
|
BookWyrm est un réseau social pour garder la trace de vos lectures, parler de livres, écrire des critiques et découvrir quoi lire ensuite.
|
||||||
|
|
||||||
|
|
||||||
**Version incluse :** 0.5.4~ynh1
|
**Version incluse :** 0.6.0~ynh1
|
||||||
|
|
||||||
**Démo :** https://joinbookwyrm.com/fr/
|
**Démo :** https://joinbookwyrm.com/fr/
|
||||||
|
|
||||||
|
@ -27,18 +27,6 @@ BookWyrm est un réseau social pour garder la trace de vos lectures, parler de l
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Avertissements / informations importantes
|
|
||||||
|
|
||||||
Ce projet est encore jeune et n'est pas, pour le moment, très stable, faites preuve de prudence lors de son utilisation en production.
|
|
||||||
|
|
||||||
Générez le code administrateur avec ``` sudo -u bookwyrm /var/www/bookwyrm/venv/bin/python3 /var/www/bookwyrm/manage.py admin_code```, et copiez le code administrateur à utiliser lors de la création de votre compte administrateur. Vous pouvez obtenir votre code à tout moment en réexécutant cette commande. Voici un exemple de sortie :
|
|
||||||
|
|
||||||
```bash
|
|
||||||
*******************************************
|
|
||||||
Use this code to create your admin account:
|
|
||||||
c6c35779-af3a-4091-b330-c026610920d6
|
|
||||||
*******************************************
|
|
||||||
```
|
|
||||||
## Documentations et ressources
|
## Documentations et ressources
|
||||||
|
|
||||||
* Site officiel de l’app : <https://joinbookwyrm.com/fr/>
|
* Site officiel de l’app : <https://joinbookwyrm.com/fr/>
|
||||||
|
|
|
@ -5,7 +5,7 @@ name = "BookWyrm"
|
||||||
description.en = "Platform for social reading"
|
description.en = "Platform for social reading"
|
||||||
description.fr = "Plateforme de lecture sociale"
|
description.fr = "Plateforme de lecture sociale"
|
||||||
|
|
||||||
version = "0.5.4~ynh1"
|
version = "0.6.0~ynh1"
|
||||||
|
|
||||||
maintainers = ["oufmilo"]
|
maintainers = ["oufmilo"]
|
||||||
|
|
||||||
|
@ -15,13 +15,15 @@ website = "https://joinbookwyrm.com/fr/"
|
||||||
demo = "https://joinbookwyrm.com/fr/"
|
demo = "https://joinbookwyrm.com/fr/"
|
||||||
admindoc = "https://docs.joinbookwyrm.com/"
|
admindoc = "https://docs.joinbookwyrm.com/"
|
||||||
code = "https://github.com/bookwyrm-social/bookwyrm"
|
code = "https://github.com/bookwyrm-social/bookwyrm"
|
||||||
|
cpe = "cpe:2.3:a:joinbookwyrm:bookwyrm"
|
||||||
|
fund = ["https://patreon.com/bookwyrm", "https://opencollective.com/bookwyrm"]
|
||||||
|
|
||||||
[integration]
|
[integration]
|
||||||
yunohost = ">= 11.1.14"
|
yunohost = ">= 11.1.16"
|
||||||
architectures = "all"
|
architectures = "all"
|
||||||
multi_instance = false
|
multi_instance = false
|
||||||
ldap = "not_relevant"
|
ldap = false
|
||||||
sso = "not_relevant"
|
sso = false
|
||||||
disk = "50M"
|
disk = "50M"
|
||||||
ram.build = "50M"
|
ram.build = "50M"
|
||||||
ram.runtime = "50M"
|
ram.runtime = "50M"
|
||||||
|
@ -49,8 +51,11 @@ ram.runtime = "50M"
|
||||||
[resources.sources]
|
[resources.sources]
|
||||||
|
|
||||||
[resources.sources.main]
|
[resources.sources.main]
|
||||||
url = "https://github.com/bookwyrm-social/bookwyrm/archive/refs/tags/v0.5.4.tar.gz"
|
url = "https://github.com/bookwyrm-social/bookwyrm/archive/refs/tags/v0.6.0.tar.gz"
|
||||||
sha256 = "2dafdcf26de6c041611d16ed48b751cf8d4dfbee1f5cf4aa5975592bc080261d"
|
sha256 = "65d43f051ed5d6c31432511bbd98b8160c0e2e13f2dafd940ece7e71d24b9a32"
|
||||||
|
|
||||||
|
autoupdate.strategy = "latest_github_tag"
|
||||||
|
|
||||||
|
|
||||||
[resources.system_user]
|
[resources.system_user]
|
||||||
|
|
||||||
|
|
|
@ -67,6 +67,7 @@ ynh_script_progression --message="Upgrading database..." --weight=1
|
||||||
$install_dir/venv/bin/python3 "$install_dir/manage.py" compile_themes
|
$install_dir/venv/bin/python3 "$install_dir/manage.py" compile_themes
|
||||||
$install_dir/venv/bin/python3 "$install_dir/manage.py" collectstatic --no-input
|
$install_dir/venv/bin/python3 "$install_dir/manage.py" collectstatic --no-input
|
||||||
$install_dir/venv/bin/python3 "$install_dir/manage.py" populate_streams
|
$install_dir/venv/bin/python3 "$install_dir/manage.py" populate_streams
|
||||||
|
$install_dir/venv/bin/python3 "$install_dir/manage.py" makemigrations --merge --noinput
|
||||||
$install_dir/venv/bin/python3 "$install_dir/manage.py" migrate
|
$install_dir/venv/bin/python3 "$install_dir/manage.py" migrate
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
|
@ -17,4 +17,5 @@ test_format = 1.0
|
||||||
# Commits to test upgrade from
|
# Commits to test upgrade from
|
||||||
# -------------------------------
|
# -------------------------------
|
||||||
|
|
||||||
test_upgrade_from.2292d0d.name = "Upgrade from 0.5.3"
|
test_upgrade_from.2292d0d.name = "Upgrade from 0.5.3"
|
||||||
|
test_upgrade_from.7600f04.name = "Upgrade from 0.5.4"
|
Loading…
Add table
Reference in a new issue