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.

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

ci: change how upstream project is tracked #295

Merged
merged 1 commit into from
Dec 15, 2024

Conversation

krzema12
Copy link
Owner

@krzema12 krzema12 commented Dec 14, 2024

Before this change, we simply stored a hash of the latest commit in snakeyaml-engine that we ported over to snakeyaml-engine-kmp. The idea was to port the changes one after another, assuming it would be easy. However, given our latest problems to port one of the commits (#272) so that it works on all targets, it's not good to block on this single change with porting other changes.

One idea would be to note with better granularity which commits have been ported. However, it would cost us quite a bit to add this mechanism, instead of focusing on actually porting the changes.

That's why I propose changing the semantics of the counter displayed in the README: show how many changes weren't analyzed by us. In other words, as soon as we acknowledge a given upstream change by creating a proper issue in our project, we can assume this change is "analyzed". Then, in our own pace, we can take care of porting the changes, possibly doing it in parallel. Thanks to this approach, changes that are harder to port will naturally be ported later, and won't block porting easy changes, which is good for the users of the lib.

I've created these issues under a new label to track the changes to port: https://github.com/krzema12/snakeyaml-engine-kmp/issues?q=is%3Aissue+is%3Aopen+label%3A%22port+from+snakeyaml-engine%22

You can cross-reference it with https://raw.githubusercontent.com/krzema12/snakeyaml-engine-kmp/refs/heads/commits-to-upstream-badge/log-diff-between-repos.txt

@krzema12 krzema12 marked this pull request as ready for review December 14, 2024 21:18
@krzema12 krzema12 changed the title Change how upstream project is tracked ci: change how upstream project is tracked Dec 14, 2024
Copy link
Collaborator

@OptimumCode OptimumCode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looks good to me. But I would add an explanation about the counter to the README file (just to have it right by the counter itself)

@krzema12
Copy link
Owner Author

Ok, I'll add it in a separate PR!

@krzema12 krzema12 merged commit 06317b4 into main Dec 15, 2024
12 checks passed
@krzema12 krzema12 deleted the change-how-we-track-upstream-project branch December 15, 2024 12:01
@krzema12
Copy link
Owner Author

@OptimumCode #296

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants