Skip to content
This repository has been archived by the owner on Mar 28, 2023. It is now read-only.

Version Tether: Continuous packaging and versioning #14

Merged
merged 6 commits into from
Apr 1, 2020

Conversation

Shadowfiend
Copy link
Contributor

@Shadowfiend Shadowfiend commented Apr 1, 2020

This PR picks up the work in keep-core, keep-ecdsa, and tbtc to publish
new npm packages on contract migration. It adds the same functionality
to tbtc.js, and additionally updates the version string referencing tbtc to
properly integrate with tbtc's versioning.

The major changes are:

  • package.json is set to <version>-pre, with no numeric suffix.
  • A new workflow step, Bump and publish npm package, runs on master
    merge. This step updates the package version to -pre.<number>, where
    <number> represents a new, unpublished version.
  • The package is published to the main npm repository.

In the process, references to keep-ecdsa contracts are also removed so that
tbtc.js can stay only directly dependent on tbtc.

The 0.12.0-pre series is the first one that will be auto-published on
new contract deploys.
Not doing this was occasionally trying to run `npm` as if it was a file
in the current working directory.
This interface is bundled with the tbtc artifacts, while BondedECDSAKeep
comes from keep-ecdsa. Rather than depend on keep-ecdsa directly, for
now the reference is updated to the interface. In fact, the interface is
all that's necessary for tbtc.js to work correctly, since the ABI is
bound to a per-deposit instance of the contract.
No need to include tests or other helper and utility files for the
published package.
This script is very close to the one used in keep-core, keep-ecdsa, and
tbtc, and will eventually be abstracted out once the commonalities and
differences shake out.
@Shadowfiend Shadowfiend force-pushed the version-tether branch 2 times, most recently from e5e33df to ca85cd4 Compare April 1, 2020 17:30
@Shadowfiend Shadowfiend marked this pull request as ready for review April 1, 2020 17:30
The repository_dispatch trigger is limited to the `redeploy` type for
now.
Copy link
Contributor

@sthompson22 sthompson22 left a comment

Choose a reason for hiding this comment

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

One non-blocking comment, here we go!

@@ -15,7 +15,7 @@ import DepositFactoryJSON from "@keep-network/tbtc/artifacts/DepositFactory.json
import TBTCTokenJSON from "@keep-network/tbtc/artifacts/TBTCToken.json"
import FeeRebateTokenJSON from "@keep-network/tbtc/artifacts/FeeRebateToken.json"
import VendingMachineJSON from "@keep-network/tbtc/artifacts/VendingMachine.json"
import BondedECDSAKeepJSON from "@keep-network/tbtc/artifacts/BondedECDSAKeep.json"
import IBondedECDSAKeepJSON from "@keep-network/tbtc/artifacts/IBondedECDSAKeep.json"
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add a bit of color here, just for my edification?

@sthompson22 sthompson22 merged commit e692b32 into master Apr 1, 2020
@sthompson22 sthompson22 deleted the version-tether branch April 1, 2020 18:52
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants