User Guide

Usage

Method 1: Run the Notebook

1. Environment: Python 3, Jupyter Notebook (web IDE or VSCode).
2. Download filepath.ipynb to any folder and open it in Jupyter Notebook or VSCode.
3. Run the corresponding code cell for openEuler or OpenHarmony docs.
4. A final-date-time.txt file will be generated in the folder. Copy and paste the file content to Excel for subsequent operations.

Method 2 (recommended on Windows): Run the Executable File

1. Environment: Windows
2. Download the corresponding .exe0 file from exe or releases to any folder and change the extension to .exe.
3. Run the file.
4. A final-date-time.txt file will be generated in the folder. Copy and paste the file content to Excel for subsequent operations.

The fields in the txt file are as follows:

1. For openEuler docs

   PR Number	Issue ID	Issue URL	Branch	File	Lines Added	Lines Removed

2. For OpenHarmony docs

   PR Number	Issue ID	Issue URL	Assignee	Branch	File	Lines Added	Lines Removed

Resuming From Breakpoint

TL;DR: Don't touch the temporary txt files. Just run the program again.

If the program exits unexpectedly due to network or other errors DURING FILE RETRIEVAL, the final-date-time.txt file will not be generated, and the temporary files issues_xx.txt, prs_xx.txt, and branch_file_oe.txt are not removed. The issue list (issues_xx.txt) and PR list (prs_xx.txt) are quick to generate while the file list (branch_file_oe.txt) is not, so the data in branch_file_oe.txt can be reused to reduce the time required to retrieve the files again. Simply keep the temporary files and run the program.
However, if the program EXITS WHEN ACQUIRING ISSUES, you need to manually remove all the txt files and run again.

Changelog

  v0.2.7: Resumes if program exits due to network or other errors
  v0.2.6: Prints numbers of added and removed lines, outputs target branch instead of source branch
  v0.2.5: Supports issue No. up to 999999
  v0.2.4: Displays process, removes intermediate files
  v0.2.3: filepath_OpenHarmony now grabs processing issues and assignees
  v0.2.2: Refactor
  v0.2.1: Grabs issue list from web, outputs file list to a single file
  v0.2.2: Fix incorrect splitting when file name contains space