Running Changelog Generator allows you to

• Create test runs
• Generate release notes
• Generate the exclusion list

Before you begin

1. Download and install Python3 : https://www.python.org/downloads/

2. If you haven’t already set up a ‘Development’ directory for github so you can clone repositories,

   • Create a Development directory
   • Open terminal, type mkdir Development

   This document assumes this is where you create this directory. You will need to adjust accordingly if you create this directory elsewhere.

First time stuff - getting set up

1. Open Terminal and navigate to your Development directory.

2. Type: git clone [email protected]:brave/qa-resources.git

3. Press Enter/Return. You have now cloned the qa-resources repo onto your machine.

4. Next, you’ll need to install the pygithub package. This gives you the shared code needed to use GitHub’s public api.

   • Open a Terminal and type: pip3 install PyGithub Then select Enter/Return.

   • FYI - You can get information on this pygithub package here: http://pygithub.readthedocs.io/en/latest/introduction.html
     and the main library of packages can be found here: https://pypi.python.org/pypi

5. In the qa-resources folder, create a file called github.secret. To do this in your Terminal session change directory to qa-resources if you are not already inside the directory. Then type touch github.secret and select Enter/Return.

6. Next, you have to create a github key.

   • Login to your github account and navigate to https://github.com/settings/token

   • Select Tokens (Classic)

   • Click on Generate new token button.

   • Give the token a meaningful name and select gist, repo, workflow checkboxes below for your token.

   • Select Generate token button. Your token is now generated, it looks similar to an SHA. Copy the token. Do not exit this page yet.

7. Add this token to your github.secret file.

   • To do this, in your Terminal session change directory to qa-resources if you are not already inside the directory.

   • Then type vi github.secret and select Enter/Return.

   • Since you’ve already copied your token, type i and paste your token. Then hit the Esc key.

   • Now type :wq to save and exit the file.

   • If you want to verify that the token was saved correctly, you can type cat github.secret and your token will display.

Running the Changelog Generator

1. Open a Terminal session.

2. Change directory to where you have qa-resources.

3. Determine what product you want to run the changelog-generator for (browser-laptop, Android, iOS) and if you want to create issues in github or just see the output in the terminal.

   • For simulating creation of test runs

     • In the terminal type python3 brave_testrun_generator.py --test true and select Enter/Return.
     • Follow options on screen to simulate generating test runs. It will just displays the output in the terminal and does NOT create GitHub issues.

   • For Tor/IPFS:

     • Ensure milestones are created before running the test run generator.
     • Selecting the number option won't generate test runs for Tor/IPFS, need to type in Tor/IPFS respectively.

Format of terminal output

General format of the output in the terminal is as follows. Enter the number for which you want to generate test runs

Rate Limit: 5000
Rate Remaining: some number

##########################################################################################################################

For Desktop or Android minor CR bump only use the basic checks selection to generate testruns

Current open milestones for Desktop/Android
1. X.XX.x - Release
2. X.XX.x - Beta
3. X.XX.x - Nightly

Current open milestones for iOS
1. X.XX
2. X.XX
3. X.XX
4. icebox

NOTE:

For Tor Release make sure you type "Tor" or "tor" instead of the number

For IPFS Release make sure you type "IPFS/KUBO " or "ipfs/kubo" instead of the number
##########################################################################################################################

Create test runs for:

1. Desktop Release (Full manual pass)
2. Desktop Release (Basic checks for hotfix/minor Chromium bump)
3. Android Release (Full manual pass)
4. Android Release (Basic checks for hotfix/minor Chromium bump)
5. iOS Release
6. Crypto Wallet - Desktop
7. Crypto Wallet - Android
8. Crypto Wallet - iOS
9. Tor Release
10. IPFS Release

Choose the platform for which you want to generate the test run:

Misc Notes

• To get updates to the changelog-generator you can open a terminal and navigate to the /Development/qa-resources folder and type: git pull
• Be sure you never add your github.secret file to any git commits you do.
• If you uninstall Python3 for any reason, any packages you install (like PyGithub) will also be uninstalled, so you will need to install them again.