diff options
| author | 2021-03-15 00:00:25 +0100 | |
|---|---|---|
| committer | 2021-03-15 00:00:25 +0100 | |
| commit | 1c3159058fd256ec7163a29c9865dbd3dbe05f17 (patch) | |
| tree | 5b3a9df3cc709a4b370f6f03cf79c50483275344 /docs/en/developers/05_Release_new_version.md | |
| parent | 769f34e958b50e748acf6a151805f4a255df2043 (diff) | |
Quick update the doc for master renaming to edge
Diffstat (limited to 'docs/en/developers/05_Release_new_version.md')
| -rw-r--r-- | docs/en/developers/05_Release_new_version.md | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/en/developers/05_Release_new_version.md b/docs/en/developers/05_Release_new_version.md index 0cb296d0c..f4e38d0de 100644 --- a/docs/en/developers/05_Release_new_version.md +++ b/docs/en/developers/05_Release_new_version.md @@ -4,16 +4,16 @@ In order to get as much feedback as possible before a release, it's preferable t It's also recommended to make the announcement on mailing@freshrss.org. -# Check the dev status +## Check the dev status Before releasing a new version of FreshRSS, you must ensure that the code is stable and free of major bugs. Ideally, our tests should be automated and executed before any publication. You must also **make sure that the CHANGELOG file is up to date** with the updates of the version to be released. -# Git process +## Git process -```bash -$ git checkout master +```sh +$ git checkout edge $ git pull $ vim constants.php # Update version number x.y.y.z of FRESHRSS_VERSION @@ -24,15 +24,15 @@ Version x.y.z $ git push && git push --tags ``` -# Updating `update.freshrss.org` +## Updating `update.freshrss.org` It's important to update update.freshrss.org since this is the default service for automatic FreshRSS updates. -The repository managing the code is located on GitHub: [FreshRSS/update.freshrss.org] (https://github.com/FreshRSS/update.freshrss.org/). +The repository managing the code is located on GitHub: [FreshRSS/update.freshrss.org](https://github.com/FreshRSS/update.freshrss.org/). ## Writing the update script -The scripts are located in the `./scripts/` directory and must take the form `update_to_x.y.z.z.php`. This directory also contains `update_to_dev.php` intended for updates of the `master` branch (this script must not include code specific to a particular version!) and `update_util.php`, which contains a list of functions useful for all scripts. +The scripts are located in the `./scripts/` directory and must take the form `update_to_x.y.z.z.php`. This directory also contains `update_to_dev.php` intended for updates of the `edge` branch (this script must not include code specific to a particular version!) and `update_util.php`, which contains a list of functions useful for all scripts. In order to write a new script, it's better to copy/paste the last version or to start from `update_to_dev.php`. The first thing to do is to define the URL from which the FreshRSS package will be downloaded (`PACKAGE_URL`). The URL is in the form of `https://codeload.github.com/FreshRSS/FreshRSS/zip/x.y.z`. @@ -67,7 +67,7 @@ return array( And here's how this table works: * on the left you can find the N version, on the right the N+1 version; -* the `x.y.z.z-dev` versions are **all** updated to `master`; +* the `x.y.z.z-dev` versions are **all** updated to `edge`; * stable versions are updated to stable versions; * it's possible to skip several versions at once, provided that the update scripts support it; * it's advisable to indicate the correspondence of the current version to its potential future version by specifying that this version does not yet exist. As long as the corresponding script does not exist, nothing will happen. @@ -80,14 +80,14 @@ Before updating update.freshrss.org, it's better to test with dev.update.freshrs When you're satisfied, update update.freshrss.org with the new script, test it again, and then move on. -# Updating the FreshRSS services +## Updating the FreshRSS services Two services need to be updated immediately after the update. * rss.freshrss.org; * demo.freshrss.org (public login: `demo` / `demodemo`). -# Publicly announce the release +## Publicly announce the release When everything's working, it's time to announce the release to the world! @@ -96,10 +96,10 @@ When everything's working, it's time to announce the release to the world! * on Twitter ([@FreshRSS](https://twitter.com/FreshRSS) account) * and on mailing@freshrss.org -# Starting the next development version +## Starting the next development version -```bash -$ git checkout master +```sh +$ git checkout edge $ vim constants.php # Update the FRESHRSS_VERSION $ vim CHANGELOG.md |
