Skip to content

Commit ead8a77

Browse files
authored
chore: remove workaround for pdd and JSON conversion
[skip ci]
1 parent 2e869e4 commit ead8a77

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/decisions-log.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
| 22.06.2023 Workaround | [php-coder/mystamps#1610](https://github.com/php-coder/mystamps/issues/1610): in the `connect-todos-to-issues.sh` script, we use [**`gh`** cli tool](https://cli.github.com) for searching issues by its title. But it's turned out that it searches issues with titles that contain a phrase while we need an *exact match*. Discussion: [link](https://github.com/orgs/community/discussions/17956) Commit: [c02dc39a](https://github.com/php-coder/mystamps/commit/c02dc39a7357d30e8c8f74c346e5fc4b81122140)<br />UPDATE(28.06.2023): I'm going to add a workaround for that by filtering out the titles within the script. Commit: [1c5c0c2b](https://github.com/php-coder/mystamps/commit/1c5c0c2bd94d083114e05f0d43d4bfb727e84125) Issue: [#1618](https://github.com/php-coder/mystamps/issues/1618) |
1111
| 16.06.2023 Workaround | [php-coder/mystamps#1610](https://github.com/php-coder/mystamps/issues/1610): in one of the releases **pdd** has changed it's behavior for parsing of the multiline comments: previously, in order to be included in a title, the next line should have started from a space. The current behavior is that pdd reads all the next lines until a comment ends or the next puzzle appears. I had to modify the existing comments in order to make their titles look as expected. I also submitted an issue to the upstream in order to improve documentation regarding these rules. Commits: [c2adb2aa](https://github.com/php-coder/mystamps/commit/c2adb2aad0ea58a1aee85cbe4aa5838dfb70f510) Issue: [cqfn/pdd#224](https://github.com/cqfn/pdd/issues/224) |
1212
| 16.06.2023 Workaround | [php-coder/mystamps#1610](https://github.com/php-coder/mystamps/issues/1610): **pdd** incorrectly parses single line HTML comments and doesn't remove a trailing `-->` characters. They are being included in a title and it looks ugly. I have already reported that issue a few years back, but the issue got closed with a suggestion to modify the comments and make them multiline. I followed that advice and modified the comments. Commits: [20b47a73](https://github.com/php-coder/mystamps/commit/20b47a733533bfdd93164a1fd77e6f23e03a1ea2) Bug: [cqfn/pdd#111](https://github.com/cqfn/pdd/issues/111) |
13-
| 12.06.2023 Workaround | [php-coder/mystamps#1610](https://github.com/php-coder/mystamps/issues/1610): in order to work with `pdd.xml` that is generated by **pdd**, I needed a simple cli tool. I'd like to use `jq` for that purpose, but pdd doesn't support JSON as an output format. I created a feature request for that and I also wrote `pdd-xml-to-json.sh` to use as a workaround. Despite that later I have decided to use TSV as a primary format, I still use JSON as an intermediary format. Commits: [597aabf5](https://github.com/php-coder/mystamps/commit/597aabf5c2ca7f5406d81fed067e5e49dc91af1f) Issue: [cqfn/pdd#223](https://github.com/cqfn/pdd/issues/223) |
13+
| ~~12.06.2023 Workaround~~ | ~~[php-coder/mystamps#1610](https://github.com/php-coder/mystamps/issues/1610): in order to work with `pdd.xml` that is generated by **pdd**, I needed a simple cli tool. I'd like to use `jq` for that purpose, but pdd doesn't support JSON as an output format. I created a feature request for that and I also wrote `pdd-xml-to-json.sh` to use as a workaround. Despite that later I have decided to use TSV as a primary format, I still use JSON as an intermediary format. Commits: [597aabf5](https://github.com/php-coder/mystamps/commit/597aabf5c2ca7f5406d81fed067e5e49dc91af1f) Issue: [cqfn/pdd#223](https://github.com/cqfn/pdd/issues/223)~~<br />UPDATE(27.05.2024): the script was removed after upgrading pdd to 0.24.0 that supports JSON format. Commits: [3bf056f6](https://github.com/php-coder/mystamps/commit/3bf056f69d146f735cfc198572ff524112f22737), [b7a7af8f](https://github.com/php-coder/mystamps/commit/b7a7af8f130c023240de46320d1712d7275f2ada), [33d062c8](https://github.com/php-coder/mystamps/commit/33d062c8e7149311050f3379a3504de987fa19be), [f25ef349](https://github.com/php-coder/mystamps/commit/f25ef3494e4b32fddfc44308f976bf75704f2718), [2e869e4b](https://github.com/php-coder/mystamps/commit/2e869e4b073b589ab9254d5eace49d958509b1e4) |
1414
| 30.05.2023 Decision | [php-coder/mystamps#1595](https://github.com/php-coder/mystamps/issues/1595): The rate of issues that I faced with pdd/**0pdd** is too high. Time to time, it tries to create the duplicated issues or close issues while the comments are still in place. Also the issues that have been reported to upstream didn't have reaction from the maintainers for a long time. I decided that its cons overweight the pros and I dicontinued a usage of 0pdd. At the same time, the approach is still seems useful so I'm going to create my own solution that will be based on pdd and Github Actions (see [php-coder/mystamps#1610](https://github.com/php-coder/mystamps/issues/1610)). While pdd also has bugs and it isn't actively maintained, neverthereless I can fix the code by myself or I will be able to add workarounds if needed. |
1515
| 04.12.2022 Decision | [php-coder/mystamps#1600](https://github.com/php-coder/mystamps/issues/1600): during migration from Travis CI to GitHub Action ([php-coder/mystamps#1154](https://github.com/php-coder/mystamps/issues/1154)) I had to make a decision whether to port **Danger** or not. While I like the idea, I came to conclusion that I shouldn't port it and hence we will discontinue its usage. The main reason is that the project has no contributors other than myself, so I don't see a reason to invest my time to its migration. Even apart of migration, it still took time for maintenance, for instance, when a new tool is added. Also we used a version written on Ruby and I had a plan about rewriting it to JavaScript |
1616
| ~~09.07.2022 Workaround~~ | ~~[php-coder/mystamps#1533](https://github.com/php-coder/mystamps/issues/1533): After update of **html5validator** to 0.4.2, it has turned out that, starting from 0.4.0, it requires **Python** 3.6 that we don't have on Travis CI as we still on the old Ubuntu 16.04. Until we migrate to 20.04. (see [php-coder/mystamps#1467](https://github.com/php-coder/mystamps/issues/1467)), I decided to install Python 3.6 manually. Commits: [0e09fac8](https://github.com/php-coder/mystamps/commit/0e09fac8663d6642e13c7c413d550da163d4fa95)~~<br />UPDATE(03.12.2022): in [d2110ff6](https://github.com/php-coder/mystamps/commit/d2110ff651e84a32e25cc83cd4208d357f59791c) commit I reverted this workaround because it's no longer required: as part of migration to GitHub Actions ([php-coder/mystamps#1154](https://github.com/php-coder/mystamps/issues/1154)), since commit [661444c6](https://github.com/php-coder/mystamps/commit/661444c62d91694b628351b34724fdc6d999f5a4) we use a container with Ubuntu 20.04 and Python 3.8.10 |

0 commit comments

Comments
 (0)