WeAye captain ⚓️

Aye captain ⚓ is a tool for automating generation of release notes from Jira tickets and much more

The tool takes in CSV file as input exported from Jira and the platform type of the tickets currently Android 🤖 and iOS 🍎 is supported [but other platforms can be easily extended].

It can also announce on your behalf to Slack Channels you configure and create android versions and release versions

Usage when use jira.kts

---

$  kotlin jira.kts <platform> <webhoolUrls-csv>

Example:

$  kotlin jira.main.kts android webhooksUrlSample.csv

==========================================================================================

Output:

Changes
✨ AJ-2013 	 Ship adaptive icon
✨ AJ-1995 	 Improve app startup time

Instrumentation
📈 AJ-1974 	 Add analytics event for app usage

Captain, do you want me to announce to fellow Cluebies on your behalf? Press Y/N
Y
Great! Let us start

Who is the captain for the release?
Himanshu

Great! Now, who would be your co-captain?
Nic

And lastly, what is the version we are releasing?
60.1-3000

Now, everyone knows!

Cap, Do you want me to create Jira Version and Android Release Page in Confluence for you? ("Y/N")"
Y
Sure, let me do it for you!
                                  ^
Jira Version is created & Android Release page is updated

Usage when use Aye.kts

$  kotlin Aye.kts <path-to-csv-file.csv> <platform>

Example:

$  kotlin Aye.kts ./sample.csv Android

====================

Output:

Changes
✨ AJ-2013 	 Ship adaptive icon
✨ AJ-1995 	 Improve app startup time

Instrumentation
📈 AJ-1974 	 Add analytics event for app usage

Usage when we need to announce to the Slack Channels

$  kotlin slack.main.kts <path-to-csv-file.csv> <path-to-webhook-csv-file> <platform>

Example:

$  kotlin slack.main.kts sample.csv webhooksUrl.csv android   


====================

Output:

kotlin slack.main.kts sample.csv webhooksUrl.csv android
Changes
✨ AJ-2013         	 Ship adaptive icon
✨ AJ-1995         	 Improve app startup time
Instrumentation
📈 AJ-1974         	 Add analytics event for app usage

Captain, do you want me to announce to fellow Cluebies on your behalf? Press Y/N
Y

Great! Let us start the announcement

Who is the captain for the release?
  Himanshu
Great! Now, who would be your co-captain?
  Ilke
And lastly, what is the version we are releasing?
  50 (2999)

webhookUrl.csv file you can find in shared drive folder.

Download

1. Install kotlin to run from command line read more
2. Download the Aye.kts or slack.main.kts script depending on requirement.
3. Run the Kotlin script [as described above]
4. Enjoy automation 🎉

Roadmap 🛣

• Support fetching ticket list from Jira server directly
• Ship it as command [example: aye ]
• Support configuring the emojis
• Post the result automatically on Slack [maybe]
• Use Kotlin Sequence for better performance ⚡

License

Copyright 2021 Biowink Gmbh

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.