You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`git clean -fdx` to **discard** them all (**CAUTION**)
16
-
-go on the `dev` branch and make sure is up-to-date with remote:
16
+
-switch to the `dev` branch and make sure it is up-to-date with the remote:
17
17
-`git checkout dev`
18
18
-`git pull origin dev`
19
19
20
20
#### Version name and conventions
21
21
22
-
- find the version code of the next release by looking for `versionCode`into[`app/build.gradle`](https://github.com/TeamNewPipe/NewPipe/blob/dev/app/build.gradle): that value plus one (from now on called `NEW_VERSION_CODE`) will be the new value (but do not edit the file yet)
22
+
- find the version code of the next release by looking for `versionCode`in[`app/build.gradle`](https://github.com/TeamNewPipe/NewPipe/blob/dev/app/build.gradle): 1 added to that value (from now on called `NEW_VERSION_CODE`) will be the new value (but do not edit the file yet)
23
23
- choose the version number of the next release according to [semantic versioning](http://semver.org/) (from now on called `X.X.X`)
24
24
25
25
#### Identification
26
26
27
27
- have `gpg` installed and usable on your PC
28
-
- have a GPG key to be used to make sure it is actually you
28
+
- have a GPG key, which can be used to verify that a file is really from you
29
29
30
30
### Pull changes from Weblate
31
31
@@ -53,10 +53,10 @@
53
53
### Create a changelog
54
54
55
55
- finalize the draft changelog [kept on GitHub](https://github.com/TeamNewPipe/NewPipe/releases), in case there are still some things to fill in
56
-
- remove temporary instructions and numbers before `-`, that keep track in which order the PRs were merged, but which is useful information only for blogpost writers
56
+
- remove the temporary instructions, and the numbers before `-` which keep track of the order in which the PRs were merged, as that info is useful only for the blog post writers
57
57
- before removing that information, you may want to send the original changelog to the blogpost writers
58
58
- create a new English changelog in the [`fastlane/metadata/android/en-US/changelogs/`](https://github.com/TeamNewPipe/NewPipe/blob/dev/fastlane/metadata/android/en-US/changelogs/) folder
59
-
- the file should be named `NEW_VERSION_CODE.txt`, using the new version code found in [Preliminary steps](#preliminary-steps)
59
+
- the file should be named `NEW_VERSION_CODE.txt`, using the new version code found in the [Preliminary steps](#preliminary-steps)
60
60
- the file should have this structure (sections with no points can be removed):
61
61
```
62
62
New
@@ -80,15 +80,15 @@
80
80
81
81
### Push the changelog to Weblate
82
82
83
-
Now there shuold be two new commits (the Weblate and changelog ones) on your local `dev` branch which are not on NewPipe's remote `dev` branch.
83
+
Now there should be two new commits (the Weblate and changelog ones) on your local `dev` branch, which are not on NewPipe's remote `dev` branch.
84
84
- if you are an admin of the NewPipe repo, just push the changes to the remote `dev`
85
85
- `git push origin dev`
86
86
- if you are not an admin, create a pull request normally and ask someone with maintainer access to merge it
87
87
- go to [Weblate's Maintenance tab](https://hosted.weblate.org/projects/newpipe/#repository)
88
88
- press the *Update* button to update Weblate with the commit you just pushed on NewPipe's `dev` branch
89
89
- **press the *Unlock*** button to allow translators to translate the changelog and possibly other components (**do not forget this step!**)
90
90
- note that we had to do this process on NewPipe's `dev` branch because:
91
-
- Weblate's components are connected to NewPipe's `dev` branch and will update changes from there
91
+
- Weblate's components are connected to NewPipe's `dev` branch, and will update changes from there
92
92
- Weblate's git repo is not writable, so there is no way to push commits there manually
93
93
94
94
### Creating the release branch
@@ -97,11 +97,11 @@ Now there shuold be two new commits (the Weblate and changelog ones) on your loc
97
97
- `git checkout -b release-X.X.X`
98
98
- edit the [`app/build.gradle`](https://github.com/TeamNewPipe/NewPipe/blob/dev/app/build.gradle) file to update the extractor
99
99
- set the NewPipeExtractor dependency version to a suitable one (usually [the last commit in the NewPipeExtractor repo](https://github.com/TeamNewPipe/NewPipeExtractor/commits/dev))
100
-
- commit the extractor update (if you used a specific version, specify `to VERSION` in the commit message)
100
+
- commit the extractor update (if you used a specific version, append `to VERSION` to the commit message)
101
101
- `git add app/build.gradle`
102
102
- `git commit -m "Update NewPipeExtractor"`
103
103
- edit the [`app/build.gradle`](https://github.com/TeamNewPipe/NewPipe/blob/dev/app/build.gradle) file to bump the release
104
-
- set `versionCode` to `NEW_VERSION_CODE`, i.e. increment the value by one as described in [Preliminary steps](#preliminary-steps)
104
+
- set `versionCode` to `NEW_VERSION_CODE`, i.e. increment the value by 1 as described in the [Preliminary steps](#preliminary-steps)
105
105
- set `versionName` to `"X.X.X"`
106
106
- commit the version bump (try to stick to the provided commit message template)
107
107
- `git add app/build.gradle`
@@ -115,14 +115,14 @@ Now there shuold be two new commits (the Weblate and changelog ones) on your loc
115
115
- if you used the correct branch name you should be able to use this url, after changing the X.X.X: https://github.com/TeamNewPipe/NewPipe/pull/new/release-X.X.X
116
116
- make sure the PR has `master` as the *base* branch and `release-X.X.X` as the *compare* branch
117
117
- the PR title should be "Release vX.X.X (NEW_VERSION_CODE)"
118
-
- remove all of the PR template and instead put these two lines in the description (the `ISSUE_NUMBER` will be replaced later):
118
+
- remove the entire PR template, and instead put these two lines in the description (the `ISSUE_NUMBER` will be replaced later):
119
119
```
120
120
Do not report regressions here, but rather in the corresponding issue: #ISSUE_NUMBER
121
121
The changelog is also there.
122
122
```
123
-
- once you created the PR, note down its number (from now on called `PR_NUMBER`)
124
-
- in case some issue should be closed when the release PR is merged, link them using the "Development" tab on the right, or add a "Fixes #...." in the PR description
125
-
- *for example check out [#8231](https://github.com/TeamNewPipe/NewPipe/pull/8231) as a reference*
123
+
- once you have created the PR, note down its number (from now on called `PR_NUMBER`)
124
+
- in case some issue would be fixed when the release PR is merged, link them using the "Development" tab on the right, or add a "Fixes #...." in the PR description
125
+
- *for example, check out [#8231](https://github.com/TeamNewPipe/NewPipe/pull/8231) for reference*
126
126
127
127
### Creating the issue
128
128
@@ -135,17 +135,17 @@ Now there shuold be two new commits (the Weblate and changelog ones) on your loc
135
135
Debug APK (built by our CI in #PR_NUMBER): ...
136
136
Please report **only regressions** (i.e. new issues) here, not issues that were already present in the previous release!
137
137
```
138
-
- the `## TODO` section should contain a list of things that still need to be done before releasing, for example regressions that need to be fixed, or a reminder to merge the Weblate changelogs before releasing (use `- [ ]` to create checkbox lists)
138
+
- an optional `## TODO` section should contain a list of things that still need to be done before releasing, for example regressions that need to be fixed, or a reminder to merge the Weblate changelogs before releasing (use `- [ ]` to create checkbox lists)
139
139
- the `## NewPipeExtractor version` should contain a link to the NewPipeExtractor release this new NewPipe version will ship with (i.e. the one set in [Creating the release branch](#creating-the-release-branch))
140
-
- copy-paste the draft Markdown changelog [kept on GitHub](https://github.com/TeamNewPipe/NewPipe/releases) (you finalized it earlier in [Create a changelog](#create-a-changelog)) and put it under the `## App changelog` section
141
-
- once you created the issue, pin it using the "Pin issue" button on the right
142
-
- *for example check out [#8230](https://github.com/TeamNewPipe/NewPipe/pull/8230) as a reference*
140
+
- copy the draft Markdown changelog [kept on GitHub](https://github.com/TeamNewPipe/NewPipe/releases) (you finalized it earlier in [Create a changelog](#create-a-changelog)) to the clipboard and paste it under the `## App changelog` section
141
+
- once you have created the issue, pin it using the "Pin issue" button on the right
142
+
- *for example, check out [#8230](https://github.com/TeamNewPipe/NewPipe/issues/8230) for reference*
143
143
144
144
### Testing APKs
145
145
146
-
The first time you open the release issue and then each time some changes are made to the release PR, you should provide a debug APK in the `## Testing for regressions` section.
147
-
- wait for the Continuous Integration (CI) to finish in the PR, then download from the "Checks" tab the debug APK it has built
148
-
- rename it to `NewPipe_vX.X.X_RC1_debug.apk` where `RC1` should be incremented to `RC2`, ... each time a new APK is provided
146
+
The first time you open the release issue, and then each time some changes are made to the release PR, you should provide a debug APK in the `## Testing for regressions` section.
147
+
- wait for the Continuous Integration (CI) to finish testing the PR, then download the debug APK it will have built from the "Checks" tab
148
+
- rename it to `NewPipe_vX.X.X_RC1_debug.apk` where `RC1` should be incremented to `RC2` and so on each time a new APK is provided
149
149
- zip it and make sure the `.zip` file has the same name as the `.apk` it contains
150
150
- upload it in the issue description, replacing the `...` placeholder used above
151
151
@@ -179,7 +179,7 @@ Once enough time has passed and all regressions and TODOs have been solved, you
179
179
- `git fetch weblate`
180
180
- obtain the hash of the last commit on the `weblate/dev` remote branch
181
181
- `git log -n 1 --pretty="format:%H" weblate/dev`
182
-
- cherry pick the has you obtained above into the release branch (the one you are currently on)
182
+
- cherry pick the hash you obtained above into the release branch (the one you are currently on)
0 commit comments