Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Automatically convert todo comments in code to the issues #1610

Closed
13 tasks done
php-coder opened this issue Jun 12, 2023 · 1 comment
Closed
13 tasks done

Automatically convert todo comments in code to the issues #1610

php-coder opened this issue Jun 12, 2023 · 1 comment
Assignees
@php-coder
Labels
ADR/needed A decision has been made and it needs to be documented area/ci techdebt
Milestone
0.4.7

Comments

@php-coder
Copy link
Owner

php-coder commented Jun 12, 2023 •
edited
Loading

Follow-up to: #1595

Currently I'm investigating the idea to supply a similar automation by myself:

Checklist:

  • Generate pdd.xml
  • Generate todos-in-code.tsv
  • Generate a mapping between puzzles ids and existing issues
  • Deal with incorrect comments (with trailing --> or */)
  • Create new issues for todos without mapping
  • Cleanup
    • remove gh1595_extract_todos branch
    • remove generated-todos-test branch
  • Document
    • put a workaround for pdd/wiremock back
    • create pdd-xml-to-json.sh as pdd doesn't support JSON output (+pdd issue)
    • modify comments to avoid having next lines in a title
    • workaround: 2 search queries because github doesn't support OR
    • workaround: possible collisions because GitHub doesn't support exatch match
    • pdd: workaround for trailing --> (pdd gh111)
@php-coder php-coder added this to the 0.4.7 milestone Jun 12, 2023
@php-coder php-coder self-assigned this Jun 12, 2023
php-coder added a commit that referenced this issue Jun 12, 2023
@php-coder
ci: extract todos from code with pdd and save them into pdd.xml and t…
597aabf 
…odos-in-code.tsv

Part of #1610
php-coder added a commit that referenced this issue Jun 13, 2023
@php-coder
chore: suppress ShellCheck violation
a4c6ea4 
Should be in commit 597aabf

Relate to #1610
php-coder added a commit that referenced this issue Jun 16, 2023
@php-coder
style: modify TODO comments to workaround buggy pdd behavior and make…
20b47a7 
… titles look good

See for details: cqfn/pdd#111

Relate to #1610
php-coder added a commit that referenced this issue Jun 16, 2023
@php-coder
style: modify TODO comments to workaround pdd behavior where it uses …
c2adb2a 
…all lines as an issue title

Relate to #1610
php-coder added a commit that referenced this issue Jun 16, 2023
@php-coder
style: modify TODO comment to match with a title of the existing issue
947f7b2 
Relate to #1610
Relate to #748
php-coder added a commit that referenced this issue Jun 16, 2023
@php-coder
ci: add todos-on-github.tsv mapping that is generated by src/main/scr…
dd42c8c 
…ipts/ci/connect-todos-to-issues.sh

Part of #1610
php-coder added a commit that referenced this issue Jun 16, 2023
@php-coder
ci: add todos-on-github.tsv mapping that is generated by src/main/scr…
506b86b 
…ipts/ci/connect-todos-to-issues.sh

Part of #1610
php-coder added a commit that referenced this issue Jun 17, 2023
@php-coder
refactor: rename CREATE_COMMIT variable to PUZZLES_FILES_MODIFIED
7335f67 
Relate to #1610
php-coder added a commit that referenced this issue Jun 17, 2023
@php-coder
refactor: initialize Git variable in a single place
dcf331c 
Relate to #1610
php-coder added a commit that referenced this issue Jun 22, 2023
@php-coder
refactor: rename CREATE_COMMIT variable to PUZZLES_FILES_MODIFIED
d106ee3 
Relate to #1610
php-coder added a commit that referenced this issue Jun 22, 2023
@php-coder
refactor: initialize Git variable in a single place
0fd60da 
Relate to #1610
php-coder added a commit that referenced this issue Jun 22, 2023
@php-coder
ci: connect puzzles with GitHub issues
c02dc39 
Part of #1610
php-coder added a commit that referenced this issue Jun 22, 2023
@php-coder
ci: manually update puzzle id after changing a comment
643ac41 
The comment has been modified in 947f7b2 commit

Part of #1610
php-coder added a commit that referenced this issue Jun 22, 2023
@php-coder
ci: manually update puzzle id after changing a comment
6cc36cc 
The comment has been modified in 947f7b2 commit

The error was:
ERROR: 684-0b0d5497 => #748: issue looks identical but its body doesn't contain the puzzle id (684-0b0d5497)!
ERROR: Perhaps, the puzzle id got changed after issue creation
ERROR: Body: The puzzle 684-b075a77e (from #684) in [src/main/java/ru/mystamps/web/service/SeriesImportServiceImpl.java](https://github.com/php-coder/mystamps/blob/6091f30a29dc445f8f544cc05e359df910c67eb5/src/main/java/ru/mystamps/web/service/SeriesImportServiceImpl.java#L182-L183) has to be resolved: "Series import: add integration test for the case when parsed value don't match database"  https://github.com/php-coder/mystamps/blob/6091f30a29dc445f8f544cc05e359df910c67eb5/src/main/java/ru/mystamps/web/service/SeriesImportServiceImpl.java#L182-L183  The puzzle was created by Slava Semushin on 04-Dec-17
ERROR: Ways to resolve:
ERROR:     1) edit #748 and modify its body to contain 684-0b0d5497
ERROR:     2) manually create a mapping between this puzzle and the issue:
ERROR:        echo '684-0b0d5497\t748\topen\tmanually' >>generated-todos/todos-on-github.tsv

Part of #1610
php-coder added a commit that referenced this issue Jun 23, 2023
@php-coder
ci: create issues on GitHub for puzzles
a712820 
Part of #1610
php-coder added a commit that referenced this issue Jun 25, 2023
@php-coder
chore: highlight puzzle id in the issue's body
571541e 
Part of #1610
php-coder added a commit that referenced this issue Jun 25, 2023
@php-coder
ci: try to create new issues when files weren't modified but there is…
582cfb3 
… some puzzles without issues

Part of #1610
php-coder added a commit that referenced this issue Jun 25, 2023
@php-coder
refactor: don't hardcode repository name
9bd4739 
Part of #1610
php-coder added a commit that referenced this issue Jun 25, 2023
@php-coder
chore: fix "REPO: unbound variable" error
ece8cdb 
Correction for 582cfb3 commit.

Part of #1610
php-coder added a commit that referenced this issue Jun 25, 2023
@php-coder
chore: fix typo in variable name
9d50c57 
Correction for 582cfb3 commit.

Part of #1610
php-coder added a commit that referenced this issue Jun 25, 2023
@php-coder
chore: fix empty variables in output
4456ef2 
Correction for 582cfb3 commit.

Part of #1610
php-coder added a commit that referenced this issue Jun 25, 2023
@php-coder
chore: fix "GraphQL: Resource not accessible by integration (createIs…
adfb6ef 
…sue)" error

Part of #1610
php-coder added a commit that referenced this issue Jun 25, 2023
@php-coder
chore: fix "GraphQL: Resource not accessible by integration (createIs…
4ff4e89 
…sue)" error

Part of #1610
php-coder added a commit that referenced this issue Jun 25, 2023
@php-coder
chore: commit possibly modified todos-on-github.tsv
2263615 
Correction for 582cfb3 commit.

Part of #1610
php-coder added a commit that referenced this issue Jun 26, 2023
@php-coder
chore: fix or ignore ShellCheck violations
e5b1072 
src/main/scripts/ci/connect-todos-to-issues.sh:44:8: warning: Declare and assign separately to avoid masking return values. [SC2155]
src/main/scripts/ci/connect-todos-to-issues.sh:60:21: note: Expressions don't expand in single quotes, use double quotes for that. [SC2016]
src/main/scripts/ci/connect-todos-to-issues.sh:83:17: note: read without -r will mangle backslashes. [SC2162]
src/main/scripts/ci/connect-todos-to-issues.sh:83:32: warning: TICKET appears unused. Verify use (or export if used externally). [SC2034]
src/main/scripts/ci/connect-todos-to-issues.sh:84:19: note: Use $((..)) instead of deprecated $[..] [SC2007]
src/main/scripts/ci/connect-todos-to-issues.sh:90:38: note: Double quote to prevent globbing and word splitting. [SC2086]
src/main/scripts/ci/connect-todos-to-issues.sh:92:19: note: read without -r will mangle backslashes. [SC2162]
src/main/scripts/ci/connect-todos-to-issues.sh:92:24: warning: ID appears unused. Verify use (or export if used externally). [SC2034]
src/main/scripts/ci/connect-todos-to-issues.sh:131:18: note: echo may not expand escape sequences. Use printf. [SC2028]
src/main/scripts/ci/connect-todos-to-issues.sh:135:10: note: Double quote to prevent globbing and word splitting. [SC2086]
src/main/scripts/ci/connect-todos-to-issues.sh:144:36: note: read without -r will mangle backslashes. [SC2162]
src/main/scripts/ci/connect-todos-to-issues.sh:150:10: note: Double quote to prevent globbing and word splitting. [SC2086]
src/main/scripts/ci/connect-todos-to-issues.sh:153:19: note: read without -r will mangle backslashes. [SC2162]
src/main/scripts/ci/connect-todos-to-issues.sh:153:24: warning: SKIP_PUZZLE_ID appears unused. Verify use (or export if used externally). [SC2034]
src/main/scripts/ci/connect-todos-to-issues.sh:153:39: warning: ORIG_ISSUE appears unused. Verify use (or export if used externally). [SC2034]
src/main/scripts/ci/connect-todos-to-issues.sh:153:50: warning: SKIP_TITLE appears unused. Verify use (or export if used externally). [SC2034]
src/main/scripts/ci/connect-todos-to-issues.sh:153:61: warning: PUZZLE_FILE appears unused. Verify use (or export if used externally). [SC2034]
src/main/scripts/ci/connect-todos-to-issues.sh:156:17: note: read without -r will mangle backslashes. [SC2162]
src/main/scripts/ci/connect-todos-to-issues.sh:156:22: warning: PUZZLE_LINE_START appears unused. Verify use (or export if used externally). [SC2034]
src/main/scripts/ci/connect-todos-to-issues.sh:156:40: warning: PUZZLE_LINE_END appears unused. Verify use (or export if used externally). [SC2034]
src/main/scripts/ci/connect-todos-to-issues.sh:171:26: note: Use $((..)) instead of deprecated $[..] [SC2007]
src/main/scripts/ci/connect-todos-to-issues.sh:175:10: note: Double quote to prevent globbing and word splitting. [SC2086]

Part of #1610
php-coder added a commit that referenced this issue Jun 26, 2023
@php-coder
chore: group steps for committing the changes together so they all ha…
d40f5ac 
…ve initialized git env vars

Correction for 2263615 commit.

Part of #1610
php-coder added a commit that referenced this issue Jun 26, 2023
@php-coder
chore: fix incorrect fix of ShellCheck violation
9ef626b 
Correction for e5b1072 commit.

Part of #1610
@php-coder php-coder added ADR/needed A decision has been made and it needs to be documented area/build scripts labels Jun 26, 2023
php-coder added a commit that referenced this issue Jun 26, 2023
@php-coder
chore: add todo comments for reamaining cases
af07a03 
 Part of #1610
php-coder added a commit that referenced this issue Jun 26, 2023
@php-coder
refactor: rename MAPPING_FILE to ISSUES_MAPPING_FILE
5f32d2b 
Relate to #1610
php-coder added a commit that referenced this issue Jun 26, 2023
@php-coder
refactor: extract variable CODE_MAPPING_FILE
dca86bf 
Relate to #1610
php-coder added a commit that referenced this issue Jun 26, 2023
@php-coder
chore: fix the case when connect-todos-to-issues.sh doesn't see newly…
a1bffa5 
… added puzzles as it looked to the old file

Correction for d40f5ac commit.

Part of #1610
This was referenced Jun 26, 2023
Open
Open
php-coder added a commit that referenced this issue Jun 27, 2023
@php-coder
docs: resurrect a workaround for pdd and non-utf8 charset
9c77d27 
Relate to #1610

[skip ci]
php-coder added a commit that referenced this issue Jun 27, 2023
@php-coder
docs: document a workaround for pdd and JSON format
0745f3e 
Relate to #1610

[skip ci]
php-coder added a commit that referenced this issue Jun 27, 2023
@php-coder
docs: document a workaround for pdd a trailing --> characters
f9872c2 
Relate to #1610

[skip ci]
php-coder added a commit that referenced this issue Jun 27, 2023
@php-coder
docs: document a workaround for pdd and multiline comments
5758f35 
Relate to #1610

[skip ci]
php-coder added a commit that referenced this issue Jun 28, 2023
@php-coder
style: improve English grammar
11fdfda 
Should be in c02dc39 commit.

Relate to #1610

[skip ci]
php-coder added a commit that referenced this issue Jun 28, 2023
@php-coder
chore: split comment and add one todo for adding a workaround
1c5c0c2 
Should be in c02dc39 commit.

Relate to #1610
php-coder added a commit that referenced this issue Jun 28, 2023
@php-coder
chore: fix the case when connect-todos-to-issues.sh doesn't see newly…
3305828 
… added puzzles as the files weren't moved

Correction for a1bffa5 commit.

Relate to #1610
php-coder added a commit that referenced this issue Jun 28, 2023
@php-coder
chore: document a limitation of gh search where it can't search by ex…
70b68a7 
…act match

Relate to #1610

[skip ci]
php-coder added a commit that referenced this issue Jun 29, 2023
@php-coder
chore: document a limitation of gh search where it can't use logical …
53f6039 
…OR in a search query

Relate to #1610

[skip ci]
@php-coder
Copy link
Owner Author

Done!

@php-coder php-coder mentioned this issue Jan 14, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@php-coder php-coder

Labels
ADR/needed A decision has been made and it needs to be documented area/ci techdebt
Projects
None yet
Milestone
0.4.7
Development

No branches or pull requests
1 participant
@php-coder