[lucene-jira-archive] branch main updated: follow-up of #65. update README.

[to...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tomoko pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/lucene-jira-archive.git


The following commit(s) were added to refs/heads/main by this push:
     new 3a2fe8ae follow-up of #65. update README.
3a2fe8ae is described below

commit 3a2fe8ae7e4f3bbbd4ad9df84c6411f3563ad3bc
Author: Tomoko Uchida <to...@gmail.com>
AuthorDate: Sun Jul 24 12:11:59 2022 +0900

    follow-up of #65. update README.
---
 migration/README.md | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/migration/README.md b/migration/README.md
index 2fe3fae0..a9a11ea8 100644
--- a/migration/README.md
+++ b/migration/README.md
@@ -59,7 +59,7 @@ LUCENE-10502
 
 Downloaded attachments should be separately committed to a dedicated branch named `attachments` (or matching the `GITHUB_ATT_BRANCH` env variable) for them.
 
-### 2. (Optional) Generate Jira username - GitHub account mapping
+### 2. (Optional) Generate Jira -> GitHub account mapping
 
 See "How to Generate Account Mapping" seciton.
 
@@ -67,7 +67,7 @@ See "How to Generate Account Mapping" seciton.
 
 `src/jira2github_import.py` converts Jira dumps into GitHub data that are importable to [issue import API](https://gist.github.com/jonmagic/5282384165e0f86ef105). Converted JSON data is saved in `migration/github-import-data`.
 
-This also resolves all Jira user ID - GitHub account alignment if the account mapping is given in `mapping-data/account-map.csv`.
+This also map all Jira username to GitHub account (or Jira full name, if the corresponding GitHub account is not available) if the account mapping is given in `mapping-data/account-map.csv` and `mapping-data/jira-users.csv`.
 
 Optionally, you can pass `--num_workers` option to specifiy the number of worker processes (the default value is `1`).
 
@@ -176,6 +176,9 @@ uschindler,Uwe Schindler
 jpountz,Adrien Grand
 sarowe,Steven Rowe
 ...
+
+# copy the result file to `mapping-data` directory - this is used in "3. Convert Jira issues to GitHub issues" section.
+(.venv) migration $ cp work/jira-users.csv mapping-data/jira-users.csv
 ```
 
 2. List candidate GitHub accounts