Skip to content

Commit 8585acf

Browse files
Docs: Update The Release Worflow (#10)
2 parents 609f6c9 + 3282828 commit 8585acf

1 file changed

Lines changed: 25 additions & 15 deletions

File tree

docs/dev-docs/release-workflow.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,42 @@
11
# Release Workflow
22

3-
In this file, you will find documented process about, how we release, new version of a app.
3+
In this file, you will find documented process about, how we release, new version of the app.
44

5-
> [!IMPORTANT]
6-
> This is not a practice that, we follow from top to bottom.
7-
> But it is rather, what our pre-release process look like.. (most of time)
5+
!!! Note
86

9-
1. We follow, so called `Main as Production Environment`. So, during the time of release we test the main branch code.
7+
This is not a practice that, we follow from top to bottom. But it is rather, what our pre-release process look like.. most of the times..
108

11-
2. Updated the code where ever need. (code that refer to previous version names in application codebase).
9+
1. We first draft a new release on github... with a tag, name & generate release notes in its description...
1210

13-
3. Make Documentation up-to-date. (document the main change in app, from user point of view, mostly this is done along with development.. it a kind of docs review).
11+
2. We follow, so called `Main (branch) as Production Environment` practice. So, during the time of release, we test/review the code in main branch.
1412

15-
4. Update `changelog.md` & `release-notes.md` in Docs Repository.
13+
> (TBH, this step of testing and review is often skip... cuz, I am really exicted for the release and just rush though the pre-release process... But I will try to improve it....)
1614
17-
5. Draft a new release with all apk files uploaded (signed apks).
15+
3. Once the review process ends, I updated the code where-ever need. (code that refer to previous version names in application codebase. mostly, in build.gradle.kts files).
1816

19-
6. Discuss on community and check & test release app on various parameters and
17+
4. Make Documentation up-to-date. (document the main change in app, from user point of view, mostly this is done along with development.. it a kind of docs review).
2018

19+
5. Update `changelog.md` & `release-notes.md` in Docs Repository.
20+
21+
!!! Tip
22+
23+
Now, Befre 6th step.. Rebuild the app again from main branch.. to take in account for outdated/stale assets.
24+
25+
6. Upload all the apk files in github release (signed apks).
26+
27+
!!! Info
28+
29+
Always take backup of release assets.. and (essentail) outputs.. frezzed in time... Senior developers at Passcodes ([@JeelDobariya38](github.com/JeelDobariya38) & [@kudanilll](https://github.com/kudanilll)).. knows what we mean by the word "backup", what to back up and where to back up.....
30+
31+
7. Now discuss on community, check & test release app on various parameters:-
2132
- We run unit tests.
2233
- We run android tests.
2334
- And of-course, we internally as developers, also test it (manually).
2435

25-
7. Then, publish a tag in the documentaion version. (Add a tag to docs)
26-
27-
8. Then finally, click the publish release to launch a new version of app.
36+
> (TBH, i don't do this step anytime, always forget it.. this is just written in documentaion.. but this is not really a step for me in reality... cuz, I am to in hurry to release a new version)
2837
29-
9. Tell in telegram community & social media.
38+
8. Then finally, click the publish button on github to release & launch a new version of app.
3039

31-
10. Celebrate the Release.
40+
9. Tell in telegram community & social media (linkedin mostly).
3241

42+
10. Celebrate the Release. Plan the future...

0 commit comments

Comments
 (0)