Skip to content

Commit

Permalink
KON-631 Write a script to create release (#1327)
Browse files Browse the repository at this point in the history
* create script

* create script

* create script

* upd script

* rename check

* comment line

* upd code

* upd DevReadme

* upd DevReadme

* upd scrpt for hotfix

* upd script

* extract print methods

* extract print methods

* comment

* add empty line

* uncomment

* add more logs

* test comment

* add more logs

* test

* add empty line

* comment test

* extract print_method_name method

* uncommit test changes

* test

* upd script

* test

* revert test

* Upd DeveloperReadme
  • Loading branch information
nataliapeterwas authored Sep 10, 2024
1 parent 057b30b commit 35e8934
Show file tree
Hide file tree
Showing 4 changed files with 944 additions and 47 deletions.
63 changes: 17 additions & 46 deletions DeveloperReadme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,57 +18,28 @@
artefact will be transferred to [maven central](https://central.sonatype.com/artifact/com.lemonappdev/konsist)
repository after some time.

## Production Release

1. Run `/scripts/create_release.py` script
2. Select option `1` on the console
3. (If needed) Remove deprecated API
4. Run `./gradlew publish -Pkonsist.releaseTarget=release` on the `main` branch to release a new version
5. (If needed) Change `Fix versions` for unfinished tickets assigned to this release version
6. Notify the community about the release
7. Notify devs who have reported the issue or asked for the new feature (community links in original ticket)

## Hotfix Release

1. Create `hotfix/KON-XXX-...` branch from `main`
2. Fix the bug and open PR targeting `mian`
2. Fix the bug and open PR targeting `main`
3. Merge the PR
4. Create `release/vX.Y.Z` branch from `main`
5. Update Konsist version
1. [gradle.properties](gradle.properties) file
2. [README.md](README.md) file
3. Sample projects
6. Open the release PR targeting `main` and wait for all checks to pass
7. Merge PR
8. Switch to the `main` branch and pull changes
9. Run `./gradlew publish -Pkonsist.releaseTarget=release` on the `main` branch to release a new version
10. Create a new [GitHub release](https://github.com/LemonAppDev/konsist/releases/new)
1. set `vX.Y.Z` as tag version
2. set `vX.Y.Z` as release title
11. Update Konsist version in the
Konsist [Quick Start](https://app.gitbook.com/o/PQj191UX5M2C2XxCZuYO/s/RYeSMx6WDKivnwWx7PdP/getting-started/getting-started)
docs page
12. Run `/scripts/deploy_snippets_to_kotlin_documentation_repo.py` snippet to generate PR with updated snippets for Konsist Documentation
13. Merge `main` to `develop`
14. Upgrade `konist` version on `develop` branch
15. Notify devs who have reported the issue (community link in original ticket)

## Production Release
4. Run `/scripts/create_release.py` script
5. Select option `2` on the console
6. (If needed) Remove deprecated API
7. Run `./gradlew publish -Pkonsist.releaseTarget=release` on the `main` branch to release a new version
8. Notify the community about the release
9. Notify devs who have reported the issue (community link in original ticket)

1. Merge `main` to `develop`
2. Create `release/vX.Y.Z` branch from `develop`
3. Update Konsist version
1. [gradle.properties](gradle.properties) file
2. [README.md](README.md) file
4. Remove deprecated API
5. Open PR targeting `main` and wait for all checks to pass
6. Release local artifact and test 3rd party projects using local artifact
1. [Android-showcase](https://github.com/igorwojda/android-showcase)
2. Mango (internal)
3. [CleanArchitectureForAndroid](https://github.com/EranBoudjnah/CleanArchitectureForAndroid)
7. Merge PR to `main`
8. Run `./gradlew publish -Pkonsist.releaseTarget=release` on the `main` branch to release a new version
9. Create a new [GitHub release](https://github.com/LemonAppDev/konsist/releases/new)
1. set `vX.Y.Z` as tag version
2. set `vX.Y.Z` as release title
10. Update Konsist version in the
Konsist [Quick Start](https://app.gitbook.com/o/PQj191UX5M2C2XxCZuYO/s/RYeSMx6WDKivnwWx7PdP/getting-started/gettingstarted)
docs page
11. Run `/scripts/deploy_snippets_to_kotlin_documentation_repo.py` snippet to generate PR with updated snippets for
Konsist Documentation
12. Merge `main` to `develop` (`release` branch will have changes e.g. version, deprecated APi removed...)
13. Notify the community about the release
14. Notify devs who have reported the issue or asked for the new feature (community links in original ticket)

## Sonatype

Expand Down
2 changes: 1 addition & 1 deletion lib/src/snippet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ The snippets are placed here to ensure that the documentation always reflects th
functional code.

To update GitBook documentation run
[deploy_snippets_to_kotlin_documentation_repo.py](../../../scripts/deploy_snippets_to_kotlin_documentation_repo) script.
[deploy_snippets_to_konsist_documentation_repo.py](../../../scripts/deploy_snippets_to_konsist_documentation_repo) script.
Loading

0 comments on commit 35e8934

Please sign in to comment.