GNOME.org
 

[pitivi] docs: Update release notes

commit 4939c00b157ceb020e8846baa2811c3335feb982
Author: Alexandru Băluț <alexandru balut gmail com>
Date:   Thu Oct 1 19:51:02 2020 +0200

    docs: Update release notes

 docs/Install_with_flatpak.md | 42 +++++++++++++++----------------------
 docs/Past_GSoCs.md           |  2 +-
 docs/release.md              | 49 +++++++++++++++++++++++++++++++-------------
 3 files changed, 52 insertions(+), 41 deletions(-)
---
diff --git a/docs/Install_with_flatpak.md b/docs/Install_with_flatpak.md
index c06a374ed..ff7de58ba 100644
--- a/docs/Install_with_flatpak.md
+++ b/docs/Install_with_flatpak.md
@@ -1,13 +1,15 @@
 # Install with flatpak
 
-The Pitivi community supports a [flatpak](http://flatpak.org/)
-repository to let users install the latest Pitivi releases. This is the
-official, recommended way of installing Pitivi on Linux. The repository
-contains only 64-bit builds.
+We release every few months, meaning you most likely want to install the latest
+release [from Flathub](https://flathub.org/apps/details/org.pitivi.Pitivi).
 
-If you see problems, come to our [IRC
-channel](http://www.pitivi.org/?go=contact) or [file a
-bug](Bug_reporting.md).
+To try out the latest development branch, get the development snapshot from our
+own [flatpak](http://flatpak.org/) repository. The repository contains only
+64-bit builds.
+
+Please [file an issue](Bug_reporting.md) if you have exact steps to reproduce
+the bug. Feel free to [contact us](http://www.pitivi.org/?go=contact) if you see
+any problems.
 
 ## Getting Flatpak
 
@@ -21,26 +23,20 @@ only one time.
 
 ## Installing Pitivi
 
-Currently there are no less than three options for installing Pitivi. Each
-can be installed by running the commands below as normal user, no root/sudo
-needed.
+Run the commands below as normal user, no root/sudo needed.
+
+### Latest release
 
-- **latest release**, for production work:
+Suited for production work.
 
 ```
 $ flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
 $ flatpak install flathub org.pitivi.Pitivi
 ```
 
-- **1.0 development snapshot**, for testing the next release:
-
-```
-$ flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
-$ flatpak install flathub org.gnome.Platform//3.36
-$ flatpak install http://flatpak.pitivi.org/pitivi.flatpakref
-```
+### Development snapshot
 
-- **master development snapshot**, which includes the latest features:
+Built daily out of the development branch.
 
 ```
 $ flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
@@ -71,7 +67,7 @@ $ flatpak run org.pitivi.Pitivi//0.96
 
 ## Updating Pitivi
 
-If your software manager doesn't allow this yet, updating manually by running:
+If your software manager doesn't allow this yet, update manually by running:
 
 ```
 $ flatpak update org.pitivi.Pitivi
@@ -91,9 +87,3 @@ $ flatpak uninstall org.pitivi.Pitivi
 
 In the sandbox gstreamer-vaapi is installed but it requires the
 `org.freedesktop.Platform.VAAPI.Intel` extension to be installed.
-
-As the support is experimental, you need to set `PITIVI_UNSTABLE_FEATURES`
-to enable them:
-```
-$ flatpak run --env=PITIVI_UNSTABLE_FEATURES=vaapi org.pitivi.Pitivi
-```
diff --git a/docs/Past_GSoCs.md b/docs/Past_GSoCs.md
index 4e9d967cb..89a7455cc 100644
--- a/docs/Past_GSoCs.md
+++ b/docs/Past_GSoCs.md
@@ -37,7 +37,7 @@ get involved.
     timelines](https://swaynethoughts.wordpress.com/2019/08/25/gsoc-2019-final-report/).
 -   [Yatin Maan](https://yatinmaan.github.io/) improved the [effects
     usability](https://yatinmaan.github.io/2019/08/26/GSoC-19-Final-Report/).
-    The Effects Library has been refactored to
+    The Effects Library has been refactored to provide a better experience.
 
 ## 2018
 
diff --git a/docs/release.md b/docs/release.md
index 0ff71c428..d9b5809a4 100644
--- a/docs/release.md
+++ b/docs/release.md
@@ -16,7 +16,7 @@ environment](HACKING.md):
 
 ```
 $ source bin/pitivi-env
-(ptv-flatpak) $
+(ptv-flatpak) $ _
 ```
 
 1. Check [GitLab](https://gitlab.gnome.org/GNOME/pitivi/milestones)
@@ -25,14 +25,21 @@ $ source bin/pitivi-env
     * Close the current milestone.
 
 2. Check your local dev env:
-    * Make sure your sandbox is using the latest GStreamer release: `$ ptvenv --update`
-    * Check `$ git status` does not show any change
+    * Make sure your sandbox is using the latest GStreamer release:
+      ```
+      $ ptvenv --update
+      ```
+
+    * Check there are no uncommitted changes:
+      ```
+      $ git status
+      ```
 
 3. Update the following files:
     * [meson.build](https://gitlab.gnome.org/GNOME/pitivi/blob/master/meson.build):
-If doing a bugfix release, add or increase the micro.
-If doing a regular release, bump YY up and remove the micro from
-the version number, for example: 0.97.1 -> 0.98. Normally this is the
+If doing a bugfix release, make sure the micro (Z) from the version number has
+been increased. If doing a regular release, update the version number with the
+current year and month and remove the micro, if any. Normally this is the
 same as the name of the GitLab milestone you just archived.
      * 
[data/org.pitivi.Pitivi.appdata.xml.in](https://gitlab.gnome.org/GNOME/pitivi/blob/master/data/org.pitivi.Pitivi.appdata.xml.in):
 Add a new release entry with the exec summary of changes.
@@ -41,14 +48,19 @@ Copy the exec summary of changes also here. This ends up in the `.news` file at
      * [AUTHORS](https://gitlab.gnome.org/GNOME/pitivi/blob/master/AUTHORS):
 If there are new maintainers.
 
-4. Commit the changes: `$ git commit -a -m "Release <version-number>"`
+4. Commit the changes:
+   ```
+   $ git commit -a -m "Release <version-number>"
+   ```
 
 5. Create the distribution archive:
    ```
    $ ninja -C mesonbuild/ dist
    $ ls -l mesonbuild/meson-dist/*.tar.*
    ```
-   On an X system, `ninja dist` might not work because the unit tests fail because of X. In this case, stop 
X and use a fake X server: `xvfb-run ninja -C mesonbuild/ dist`.
+   On an X system, `ninja dist` might not work because the unit tests fail
+   because of X. In this case, stop X with `sudo systemctl stop gdm` and use a
+   fake X server: `xvfb-run /.../pitivi/build/flatpak/pitivi-flatpak ninja -C mesonbuild/ dist`.
 
    Install it on a real system and give it a spin. For example on Archlinux:
    ```
@@ -65,19 +77,24 @@ If there are new maintainers.
    $ pitivi
    ```
 
-6. Create a tag and push it to the official repository. The TAG must always include the micro. This means 
when doing a regular release with version number X.YY, the TAG is X.YY.0. When doing a bug-fix release, the 
version number already includes a micro, so it's all fine.
+6. Create a tag and push it to the official repository. The TAG must always include the micro. This means 
when doing a regular release with version number YYYY.MM, the TAG is YYYY.MM.0. When doing a bug-fix release, 
the version number already includes a micro, so it's all fine.
    ```
    $ git tag -a <TAG> -m "Release <version-number>"
    $ git push origin <TAG>
    ```
-   We use tag X.YY.0 instead of X.YY because we want to have the option of later creating the X.YY branch to 
the official repository, since it's not possible to have both a tag and a branch with the same name. This 
branch would gather backported fixes and be used for doing future X.YY.Z bug-fix releases.
+   We use tag YYYY.MM.0 instead of YYYY.MM because we want to have the option of
+   later creating the YYYY.MM branch to the official repository, since it's not
+   possible to have both a tag and a branch with the same name. This branch
+   would gather backported fixes and be used for doing future YYYY.MM.Z bug-fix
+   releases.
 
 7. Publish the archive on Gnome:
    ```
-   $ scp mesonbuild/meson-dist/pitivi-X.YY.Z.tar.xz GNOME-USER master gnome org:
-   $ ssh GNOME-USER master gnome org -t ftpadmin install pitivi-X.YY.Z.tar.xz
+   $ scp mesonbuild/meson-dist/pitivi-YYYY.MM.tar.xz GNOME-USER master gnome org:
+   $ ssh GNOME-USER master gnome org -t ftpadmin install pitivi-YYYY.MM.Z.tar.xz
    ```
-   The tarball will appear on https://download.gnome.org/sources/pitivi/X.YY/pitivi-X.YY.Z.tar.xz
+   The tarball will appear on
+   https://download.gnome.org/sources/pitivi/YYYY.MM/pitivi-YYYY.MM.Z.tar.xz
 
 8. Spread the word about the release
     * Send an [email](https://lists.freedesktop.org/archives/gstreamer-devel/2017-September/065566.html) to 
gstreamer-devel lists freedesktop org
@@ -88,4 +105,8 @@ If there are new maintainers.
 
 9. Update http://www.pitivi.org/releases.txt for the app's update notification feature
 
-10. Bump the Z in the version number in 
[meson.build](https://gitlab.gnome.org/GNOME/pitivi/blob/master/meson.build), for example if it was a regular 
release: 0.98 -> 0.98.1 or if it was a bug-fix release: 0.97.1 -> 0.97.2, and `$ commit -a -m "Back to 
development"`
+10. Bump the Z in the version number in
+    [meson.build](https://gitlab.gnome.org/GNOME/pitivi/blob/master/meson.build),
+    for example if it was a regular release: 2020.09 -> 2020.09.1 or if it was a
+    bug-fix release: 2020.09.1 -> 2020.09.2, and `$ commit -a -m "Back to
+    development"`
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]