Skip to content

refactor(build script): rewrite the main build script#2319

Merged
shamardy merged 7 commits intodevfrom
cache-invalidation-fix
Jan 21, 2025
Merged

refactor(build script): rewrite the main build script#2319
shamardy merged 7 commits intodevfrom
cache-invalidation-fix

Conversation

@onur-ozkan
Copy link
Copy Markdown

@onur-ozkan onur-ozkan commented Jan 13, 2025 •
edited
Loading

Previous build script were highly unstable and relied on the MM_DATETIME and MM_VERSION files which was very annoying. These files caused cargo to invalidate the build cache, so even if you ran cargo build multiple times without changing anything, it would still rebuild because the build script triggered cache invalidation.

This PR makes the build script straightforward and more stable without causing cache invalidation. The final versioning output remains as is, but the implementation side is robust than ever.

Major effects:

  • No more cache invalidations.
  • The MM_VERSION and MM_DATETIME files are no longer needed in the project root.
  • Datetime handling is now more stable. Previously MM_DATETIME file could become outdated as it wasn't consistently updated.

@onur-ozkan
rewrite the main build script
2fab6c0 
Get rid of annoying file reading/writing logics

Signed-off-by: onur-ozkan <work@onurozkan.dev>
@onur-ozkan
remove outdated docs
2522712 
Signed-off-by: onur-ozkan <work@onurozkan.dev>
@onur-ozkan
update massively outdated ANDROID docs
25c8578 
Signed-off-by: onur-ozkan <work@onurozkan.dev>
@onur-ozkan
replace outdated namings in the source code
ffa03c7 
Signed-off-by: onur-ozkan <work@onurozkan.dev>
@onur-ozkan
update CI runners
5f4d0f6 
Signed-off-by: onur-ozkan <work@onurozkan.dev>
@onur-ozkan onur-ozkan force-pushed the cache-invalidation-fix branch from 3575651 to 5f4d0f6 Compare January 13, 2025 11:07
@onur-ozkan
fix fmt and linting warnings
aca6c66 
Signed-off-by: onur-ozkan <work@onurozkan.dev>
onur-ozkan
onur-ozkan commented Jan 13, 2025
View reviewed changes
docs/ANDROID.md
Copy link
Copy Markdown
Author

@onur-ozkan onur-ozkan Jan 13, 2025

Choose a reason for hiding this comment

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

We need to revise our docs... This is extremely outdated.

@onur-ozkan onur-ozkan marked this pull request as ready for review January 13, 2025 11:31
onur-ozkan
onur-ozkan commented Jan 13, 2025
View reviewed changes
mm2src/mm2_bin_lib/build.rs
Copy link
Copy Markdown
Author

@onur-ozkan onur-ozkan Jan 13, 2025

Choose a reason for hiding this comment

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

Since this is re-written from scratch, I suggest you to review this by opening the file directly as the diff view will make it likely impossible to understand the logic.

shamardy
shamardy reviewed Jan 20, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@shamardy shamardy left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the fix! Only one question for now. We will need to open a docs PR once this is approved, we need to inform QA that this is breaking as well (in case something depended on the old MM_VERSION/MM_DATETIME files).

borngraced
borngraced previously approved these changes Jan 20, 2025
View reviewed changes
Copy link
Copy Markdown

@borngraced borngraced left a comment

Choose a reason for hiding this comment

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

Thanks. I tested it locally and it's clean.

mm2src/mm2_bin_lib/build.rs
// if there is MM_VERSION file, that means CI wants to put a tag to version
if !v_file.is_empty() {
version = format!("{}_{}", version, v_file.trim());
fn version_tag() -> Result<String, String> {
Copy link
Copy Markdown

@borngraced borngraced Jan 20, 2025

Choose a reason for hiding this comment

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

not important get_version_tag seems like better naming

@onur-ozkan
detect HEAD changes
9aaa9ae 
Signed-off-by: onur-ozkan <work@onurozkan.dev>
shamardy
shamardy approved these changes Jan 21, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@shamardy shamardy left a comment

Choose a reason for hiding this comment

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

LGTM! Please open docs issue @onur-ozkan

@shamardy shamardy merged commit 453b100 into dev Jan 21, 2025
@shamardy shamardy deleted the cache-invalidation-fix branch January 21, 2025 13:35
@onur-ozkan
Copy link
Copy Markdown
Author

onur-ozkan commented Jan 21, 2025

LGTM! Please open docs issue @onur-ozkan

will do, thank you for reminding

shamardy pushed a commit that referenced this pull request Jan 28, 2025
@onur-ozkan @shamardy
refactor(build script): rewrite the main build script (#2319)
0d81f46 
This commit makes the build script straightforward and more stable without causing cache invalidation. The final versioning output remains as is, but the implementation side is robust than ever.
shamardy pushed a commit that referenced this pull request Jan 30, 2025
@onur-ozkan @shamardy
refactor(build script): rewrite the main build script (#2319)
dac5a49 
This commit makes the build script straightforward and more stable without causing cache invalidation. The final versioning output remains as is, but the implementation side is robust than ever.
shamardy pushed a commit that referenced this pull request Jan 30, 2025
@onur-ozkan @shamardy
refactor(build script): rewrite the main build script (#2319)
3bdc1f0 
This commit makes the build script straightforward and more stable without causing cache invalidation. The final versioning output remains as is, but the implementation side is robust than ever.
dimxy pushed a commit to dimxy/komodo-defi-framework that referenced this pull request Feb 4, 2025
Merge branch 'dev' into burn-dex-fee-for-non-kmd
2645517 
* dev:
  fix(hash-types): remove panic, enforce fixed-size arrays (GLEECBTC#2279)
  fix(ARRR): store unconfirmed change output (GLEECBTC#2276)
  feat(tendermint): staking/delegation (GLEECBTC#2322)
  chore(deps): `timed-map` migration (GLEECBTC#2247)
  fix(mem-leak): `running_swap` never shrinks (GLEECBTC#2301)
  chore(dep-bump): libp2p (GLEECBTC#2326)
  refactor(build script): rewrite the main build script (GLEECBTC#2319)
dimxy pushed a commit to dimxy/komodo-defi-framework that referenced this pull request Feb 4, 2025
Merge branch 'dev' into burn-dex-fee-for-non-kmd
114cfe9 
* dev:
  fix(hash-types): remove panic, enforce fixed-size arrays (GLEECBTC#2279)
  fix(ARRR): store unconfirmed change output (GLEECBTC#2276)
  feat(tendermint): staking/delegation (GLEECBTC#2322)
  chore(deps): `timed-map` migration (GLEECBTC#2247)
  fix(mem-leak): `running_swap` never shrinks (GLEECBTC#2301)
  chore(dep-bump): libp2p (GLEECBTC#2326)
  refactor(build script): rewrite the main build script (GLEECBTC#2319)
dimxy pushed a commit that referenced this pull request Feb 16, 2025
Merge branch 'dev' into lr-swap-wip
a52ebc0 
* dev:
  fix(derive_key_from_path): check length of current_key_material (#2356)
  chore(release): bump mm2 version to 2.4.0-beta (#2346)
  fix(tests): add additional testnet sepolia nodes to test code (#2358)
  fix(swaps): maintain legacy compatibility for negotiation messages (#2353)
  refactor(SwapOps): impl defaults for protocol specific swapops fns (#2354)
  feat(tpu-v2): provide swap protocol versioning (#2324)
  feat(wallet): add change mnemonic password rpc (#2317)
  fix(tpu-v2): fix tpu-v2 wait for payment spend and extract secret (#2261)
  feat(tendermint): unstaking/undelegation (#2330)
  fix(utxo-withdraw): get hw ctx only when `PrivKeyPolicy` is trezor (#2333)
  feat(event-streaming): API-driven subscription management (#2172)
  fix(hash-types): remove panic, enforce fixed-size arrays (#2279)
  fix(ARRR): store unconfirmed change output (#2276)
  feat(tendermint): staking/delegation (#2322)
  chore(deps): `timed-map` migration (#2247)
  fix(mem-leak): `running_swap` never shrinks (#2301)
  chore(dep-bump): libp2p (#2326)
  refactor(build script): rewrite the main build script (#2319)
dimxy pushed a commit that referenced this pull request Feb 16, 2025
Merge branch 'dev' into lr-swap-wip
b86f433 
* dev:
  fix(derive_key_from_path): check length of current_key_material (#2356)
  chore(release): bump mm2 version to 2.4.0-beta (#2346)
  fix(tests): add additional testnet sepolia nodes to test code (#2358)
  fix(swaps): maintain legacy compatibility for negotiation messages (#2353)
  refactor(SwapOps): impl defaults for protocol specific swapops fns (#2354)
  feat(tpu-v2): provide swap protocol versioning (#2324)
  feat(wallet): add change mnemonic password rpc (#2317)
  fix(tpu-v2): fix tpu-v2 wait for payment spend and extract secret (#2261)
  feat(tendermint): unstaking/undelegation (#2330)
  fix(utxo-withdraw): get hw ctx only when `PrivKeyPolicy` is trezor (#2333)
  feat(event-streaming): API-driven subscription management (#2172)
  fix(hash-types): remove panic, enforce fixed-size arrays (#2279)
  fix(ARRR): store unconfirmed change output (#2276)
  feat(tendermint): staking/delegation (#2322)
  chore(deps): `timed-map` migration (#2247)
  fix(mem-leak): `running_swap` never shrinks (#2301)
  chore(dep-bump): libp2p (#2326)
  refactor(build script): rewrite the main build script (#2319)
@shamardy shamardy mentioned this pull request Apr 16, 2025
Merged
DeckerSU added a commit to DeckerSU/jenkins-ci-atomicdex that referenced this pull request May 5, 2025
@DeckerSU
build: set KDF_BUILD_TAG for Android libs build
d6a8536 
According to changes in:

GLEECBTC/komodo-defi-framework#2319
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shamardy shamardy shamardy approved these changes

+1 more reviewer

@borngraced borngraced borngraced left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

improvement: build time status: pending review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@onur-ozkan @shamardy @borngraced