René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Asterisk Java road map proposal","articleBody":"Hello :wave:\r\n\r\nDear @asterisk-java/contributors, @asterisk-java/owners and everyone who want to support us!\r\n\r\nI would like to invite all of you to this conversation.\r\nThese are the next steps of making the asterisk-java project great again.\r\n\r\n---\r\n\r\n### :exclamation: Disclaimer \r\nThis is only a *proof-of-concept* and should be treated as a *proposal* and a **base for the discussion**.\r\n\r\n\u003csub\u003eI hope responses will be faster.\u003c/sub\u003e\r\n\r\n---\r\n\r\n\u003e :bangbang:\r\n\u003e If you don't agree with any changes or proposals, **let me know** by using the reaction button, or more helpfully, by giving ***constructive feedback*** on what is wrong and how it should be handled.\r\n\r\n---\r\n\r\nI've diagnosed a couple of problematic areas.\r\n\r\n## 1. Code maintenance and releases\r\n\r\n### :boom: Problems:\r\n* Right now, releases are done by some weird Dart release scripts, which are neither Java nor GitHub friendly. \r\n* We don't have any changelog. Nowadays, this is bad practice and very uninformative.\r\n* In addition, a lot of changes are made without any issue or even a short description of the reason for changes.\r\n\r\n### :bulb: Solutions:\r\n* Do release using GitHub Releases connected with GitHub Actions and Maven Release Plugin (or another way, but using Java).\r\n* GitHub Releases helps us with the changelog.\r\n* All changes must have an appropriate issue or pull request with a short description. Master (maybe main?) should be blocked for direct pushes. Every change should be done via pull requests (for everyone!) and reviewed.\r\n\r\n## 2. Project structure\r\n\r\n### :boom: Problems:\r\n* Right now everything is mixed into one module. If you want to run only fastagi or manager - you can't.\r\n* There aren't boundaries between modules.\r\n\r\n### :bulb: Solutions:\r\nI suggest the following project structure:\r\n\r\n```\r\nasterisk-java-parent        (POM)\r\n├── asterisk-java-agi       (POM)\r\n│   ├── asterisk-java-agi-asyncagi  (JAR)    dependencies: asterisk-java-agi-command, asterisk-java-agi-core, asterisk-java-ami-manager\r\n│   ├── asterisk-java-agi-command   (JAR)\r\n│   ├── asterisk-java-agi-core      (JAR)\r\n│   └── asterisk-java-agi-fastagi   (JAR)    dependencies: asterisk-java-agi-core, asterisk-java-agi-command\r\n├── asterisk-java-ami       (POM)\r\n│   ├── asterisk-java-ami-action    (JAR)\r\n│   ├── asterisk-java-ami-event     (JAR)\r\n│   └── asterisk-java-ami-manager   (JAR)   dependencies: asterisk-java-ami-action, asterisk-java-ami-event\r\n├── asterisk-java-common    (JAR)\r\n├── asterisk-java-live      (JAR)           dependencies: asterisk-java-ami-manager\r\n└── asterisk-java-pbx       (JAR)           dependencies: asterisk-java-agi-fastagi, asterisk-java-ami-action, asterisk-java-ami-event\r\n```\r\n\r\nWhy are modules good? \r\n* They give an overview of how asterisk-java and Asterisk itself are designed. They also provide boundaries of responsibility.\r\n* Prevent mixing objects (exceptions, models, etc.) between modules.\r\n* Gives possibility to extend in the future (we can easily add e.g. ARI module).\r\n\r\n## 3. Supported versions\r\n\r\n### :boom: Problems:\r\nCurrently the project doesn't have clearly defined Asterisk and Java supported versions.\r\n\r\n### :bulb: Solutions:\r\n\r\n#### Java\r\n* All LTS versions shlould be supported and tested (8, 11, 17).\r\n* If any Java version becomes EOL, we should drop support in the next major release (for Java 8 it's 2025-03-31).\r\n\r\n#### Asterisk\r\nFor Asterisk versions 16, 18 and 20 the major should be 4.x.x. When 16 reaches its EOL in 2023-10-09, we should change\r\nthe major to 5.x.x. We should also change the major version when a new Asterisk LTS version is released.\r\n\r\n##### asterisk-java project release cycle:\r\n\r\n| Asterisk Java | Asterisk   | Java          | EOL        | Reason                                                       |\r\n|---------------|------------|---------------|------------|--------------------------------------------------------------|\r\n| 4.x.x         | 16, 18, 20 | 8, 11, 17     | 2023-10-09 | Java 21 released\u003cbr/\u003eAsterisk 16 EOL                         |\r\n| 5.x.x         | 18, 20     | 8, 11, 17, 21 | 2024-10-19 | Asterisk 22 released                                         |\r\n| 6.x.x         | 18, 20, 22 | 8, 11, 17, 21 | 2025-03-31 | Java 8 EOL                                                   |\r\n| 7.x.x         | 18, 20, 22 | 11, 17, 21    | 2025-10-20 | Asterisk 18 EOL                                              |\r\n| 8.x.x         | 20, 22     | 11, 17, 21    | 2026-10-19 | Java 11 EOL\u003cbr/\u003eJava 27(?) released\u003cbr/\u003eAsterisk 24 released |\r\n\r\n#### :exclamation: Disclaimer\r\nWith this release process I have a lot of confusion. I'm not 100% sure it's a good way to do it.\r\n\r\n## 4. Labels\r\n\r\n### :boom: Problems:\r\n* Without labels, we cannot make any automation.\r\n* Also issues and pull requests are uncategorized.\r\n\r\n### :bulb: Solutions:\r\nCreate labels and use it.\r\n\r\nConnected with particular Asterisk version.\r\n```\r\nasterisk/16\r\nasterisk/18\r\nasterisk/20\r\n...\r\n```\r\n\r\nType of issue or pull request.\r\n```\r\nkind/bug\r\nkind/breaking\r\nkind/dependencies\r\nkind/documentation\r\nkind/enhancement\r\nkind/feature\r\nkind/question\r\nkind/refactor\r\nkind/wontfix\r\n```\r\n\r\nAdditional information for issue or pull request.\r\n```\r\nmeta/skip-changelog\r\n```\r\n\r\nConnected for particular module.\r\n```\r\nmodule/agi\r\nmodule/ami\r\nmodule/live\r\nmodule/pbx\r\n```\r\n\r\n## 5. Cleanup branches\r\n\r\n### :boom: Problem:\r\nThere is a bunch of the stale branches.\r\n\r\n### :bulb: Solution:\r\nRemove all of them, and leave only master.\r\n\r\n## 6. Integration tests\r\n\r\n### :boom: Problem:\r\nRight now, there aren't any integration tests. We are not sure that our lib working with supported Asterisk versions.\r\n\r\n### :bulb: Solution:\r\nWe should running integration test for each supported Asterisk version. To achieve this, we can use Testcontainers.\r\n\r\nHere is a proof-of-concept of super easy and a little bit dumb example, but this prove it's possible to run integration tests automatically.\r\n\r\nhttps://github.com/piotrooo/asterisk-java/commit/dbefe8ba44260a72d7090caf7b46e4709343c63c\r\n\r\nTests should be run for all supported Asterisk versions.\r\n\r\n## 7. Web page asterisk-java.org\r\n\r\n### :boom: Problem:\r\nWeb page is very outdated.\r\n\r\n### :bulb: Solution:\r\n* Create new web page with introduction, modules overview, documentation, some explanations.\r\n* We should use some static site generator like [MkDocs](https://www.mkdocs.org/) or [AsciiDoc](https://asciidoc.org/) or some other.\r\n\r\n## 8. Logo\r\n\r\n### :boom: Problem:\r\nLast but not least, asterisk-java doesn't have own logo :sob:\r\n\r\n### :bulb: Solution:\r\nI've asked my good friend @tomekbbk, who is also a graphic and UX designer in company where I've working, to create logo.\r\nThis is what he designed for us:\r\n\r\n![Logo_b_textmdpi](https://user-images.githubusercontent.com/2005054/194589419-493b8786-83e4-4cfc-adde-6ad030e20361.png)\r\n\r\n![Sygnetmdpi](https://user-images.githubusercontent.com/2005054/194589515-baa36106-4b3c-4a79-9443-1247d2542887.png)\r\n\r\nBTW. Connect Java coffee cup with Asterisk logo = FTW :star_struck:\r\n\r\n---\r\n\r\n## How should we start?\r\n\r\n###### In my opinion\r\n\r\n1. Create labels for issues and pull requests and start to use them\r\n2. Cleanup release cycle - use maven plugin and generate change log (GitHub Actions and GitHub Releases)\r\n3. Block master for direct pushes\r\n4. Cleanup stale branches\r\n5. Try to address and fix at least couple of issues\r\n6. Modularize project\r\n7. Add integration tests\r\n8. Web page\r\n\r\n_After that changes, version **4.0.0** should be  #released!_\r\n\r\n---\r\n\r\n### If something needs more clarification let me know. I'll try to response.\r\n","author":{"url":"https://github.com/piotrooo","@type":"Person","name":"piotrooo"},"datePublished":"2022-10-07T14:08:54.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":4},"url":"https://github.com/405/asterisk-java/issues/405"}