+ {
+ hhlogs.map((log) => {
+ let formattedLog
+ // Hardhat implements the same formatting options that can be found in Node.js' console.log,
+ // which in turn uses util.format: https://nodejs.org/dist/latest-v12.x/docs/api/util.html#util_util_format_format_args
+ // For example: console.log("Name: %s, Age: %d", remix, 6) will log 'Name: remix, Age: 6'
+ // We check first arg to determine if 'util.format' is needed
+ if (typeof log[0] === 'string' && (log[0].includes('%s') || log[0].includes('%d'))) {
+ formattedLog = format(log[0], ...log.slice(1))
+ } else {
+ formattedLog = log.join(' ')
+ }
+ return
diff --git a/libs/remixd/src/services/foundryClient.ts b/libs/remixd/src/services/foundryClient.ts
index 96a90c5080..aa4e42f4c1 100644
--- a/libs/remixd/src/services/foundryClient.ts
+++ b/libs/remixd/src/services/foundryClient.ts
@@ -83,7 +83,7 @@ export class FoundryClient extends PluginClient {
}
if (!this.warnlog) {
// @ts-ignore
- this.call('terminal', 'log', 'receiving compilation result from Foundry')
+ this.call('terminal', 'log', { type: 'log', value: 'receiving compilation result from Foundry' })
this.warnlog = true
}
}
@@ -167,6 +167,6 @@ export class FoundryClient extends PluginClient {
console.log('syncing from Foundry')
this.processArtifact()
// @ts-ignore
- this.call('terminal', 'log', 'synced with Foundry')
+ this.call('terminal', 'log', { type: 'log', value: 'synced with Foundry'})
}
}
diff --git a/libs/remixd/src/services/hardhatClient.ts b/libs/remixd/src/services/hardhatClient.ts
index c19479766e..abef18642f 100644
--- a/libs/remixd/src/services/hardhatClient.ts
+++ b/libs/remixd/src/services/hardhatClient.ts
@@ -105,14 +105,12 @@ export class HardhatClient extends PluginClient {
}
}
if (!this.warnLog) {
- // @ts-ignore
- this.call('terminal', 'log', 'receiving compilation result from Hardhat')
+ this.call('terminal', 'log', { value: 'receiving compilation result from Hardhat', type: 'log'} )
this.warnLog = true
}
if (targetsSynced.length) {
console.log(`Processing artifacts for files: ${[...new Set(targetsSynced)].join(', ')}`)
- // @ts-ignore
- this.call('terminal', 'log', `synced with Hardhat: ${[...new Set(targetsSynced)].join(', ')}`)
+ this.call('terminal', 'log', { type: 'log', value: `synced with Hardhat: ${[...new Set(targetsSynced)].join(', ')}` })
}
}
diff --git a/libs/remixd/src/services/truffleClient.ts b/libs/remixd/src/services/truffleClient.ts
index 6dfd3b6f66..1fa745042e 100644
--- a/libs/remixd/src/services/truffleClient.ts
+++ b/libs/remixd/src/services/truffleClient.ts
@@ -81,7 +81,7 @@ export class TruffleClient extends PluginClient {
}
if (!this.warnLog) {
// @ts-ignore
- this.call('terminal', 'log', 'receiving compilation result from Truffle')
+ this.call('terminal', 'log', { type: 'log', value: 'receiving compilation result from Truffle' })
this.warnLog = true
}
}
@@ -141,6 +141,6 @@ export class TruffleClient extends PluginClient {
console.log('syncing from Truffle')
this.processArtifact()
// @ts-ignore
- this.call('terminal', 'log', 'synced with Truffle')
+ this.call('terminal', 'log', { type: 'log', value: 'synced with Truffle' })
}
}
diff --git a/release-process.md b/release-process.md
index d0f8e7f9da..013b600964 100644
--- a/release-process.md
+++ b/release-process.md
@@ -1,79 +1,102 @@
# Release process
-This document includes:
- - how to release the remixd
- - how to publish remix libs to NPM
- - how to update remix.ethereum.org
- - how to update remix-alpha.ethereum.org
- - how to update remix-beta.ethereum.org
- - how to release remix IDE
-
-## RemixD release
- - update new version number in remixd libs/remixd/package.json
- - nx build remixd
- - cd into ./dist/libs/remixd
- - npm publish
- - create bump PR to master.
-
-## Remix libs release
-(remove dist and login to npm)
- - git fetch origin master
- - git checkout origin/master
- - git checkout -b bumpLibsVersion
- - yarn run publish:libs (this command uses lerna)
- - commit
-
-## Remix IDE release Part 1. First push master to beta. Feature Freeze
- - git co -b remix_beta origin/remix_beta
- - git reset --hard -master-commit-hash-
- - git push -f origin remix_beta
-
-## Testing phase
-## In case of fixing bugs push PR's also to beta to include in Release
+This document includes the release instructions for:
+ - Feature freeze phase
+ - Publishing `remixd` to NPM
+ - Publishing remix libraries to NPM
+ - Updating Remix's live version on remix.ethereum.org
+ - Updating Remix's alpha version on remix-alpha.ethereum.org
+ - Updating Remix's beta version on remix-beta.ethereum.org
+
+## Feature Freeze
+Once feature freeze is done, `remix_beta` should be updated latest to the master which will automatically update `remix-beta.ethereum.org` through a CI job.
+
+ - `git checkout remix_beta`
+ - `git pull origin remix_beta`
+ - `git reset --hard ` (`master-commit-hash` will be latest commid id from `master` branch)
+ - `git push -f origin remix_beta`
-## Remix IDE release Part 2. Bump the version in beta and release
+## Testing
+Testing is performed after the Feature Freeze on `remix-beta.ethereum.org`. `build-qa-doc.js` script can be used to generate the list of QA tasks. Instructions to use the file are given in the file itself : https://github.com/ethereum/remix-project/blob/master/build-qa-doc.js#L18 .
- - git fetch origin remix_beta
- - git checkout origin/remix_beta
- - git checkout -b bumpVersion
- - update package.json version
- - update version in yarn.lock
- - merge PR to **origin/remix_beta**
- - git fetch origin remix_beta
- - git checkout origin/remix_beta
- - git tag v(version-number)
- - git push --tags
- - github-changes -o ethereum -r remix-project -a --only-pulls --use-commit-body --branch remix_beta --only-merges --between-tags previous_version...next_version
- - publish a release in github using the changelog
+Once ready to run, it can be run using the Node.js: `node build-qa-doc.js`
+
+## remixd NPM release
+Once testing is completed, release will start by publishing `remixd`.if required, `remixd` can be also released individually
+
+ - Bump version for remixd in `./libs/remixd/package.json`
+ - Run: `nx build remixd`
+ - Move to build directory: `cd ./dist/libs/remixd`
+ - Publish to NPM: `npm publish` (Make sure you are logged in to NPM)
+ - create bump PR to master
+
+## Remix libraries NPM release
+ - Make sure you are on latest `master` branch
+ - `git pull origin master`
+ - `git checkout -b bumpLibsVersion`
+ - `yarn run publish:libs `
-## Remix IDE release Part 3. Bump dev branch (master)
+This command uses `lerna` and is solely responsible for publishing all the remix libraries. It will ask for a new version of each library. Make sure you are logged in to NPM.
- - git fetch origin master
- - git checkout origin/master
- - git checkout -b bumpDevVersion
- - update package.json version: bump the version and add the tag `dev` if not already present.
- - update version in yarn.lock
- - create a PR and merge it to origin/master
+Once this command has been run, the versions for each remix library will be updated to latest in the libs' package.json file.
+ - Create and merge bump PR to master
-## Remix IDE release Part 4. remix.ethereum.org update
+## Remix IDE Release
+### Part 1. Bump the version and update Beta
+
+#### Make sure `remix_beta` is up-to-date with `master` branch:
+
+ - `git checkout remix_beta`
+ - `git pull origin remix_beta`
+ - `git reset --hard `
+ - `git push -f origin remix_beta`
+
+#### Create bump version PR:
+
+ - Create a new branch from `remix_beta`: `git checkout -b bumpVersion`
+ - Update package.json version. Usually, you need to remove `-dev` from the version string
+ - Create a PR with base branch as `remix_beta`
+ - Merge PR to **origin/remix_beta**
+
+#### Create git tag from beta branch:
-This is not strictly speaking a release. Updating the remix site is done through the Travis build:
+ - `git checkout remix_beta`
+ - `git pull origin remix_beta`
+ - Create tag: `git tag v`, `` should be same as in package.json of `remix_beta` branch
+ - Push tag: `git push --tags`
+ - Generate changelog using `build-changelog.js` script as described in the script itself
+ - Publish a release in GitHub using the generated changelog
- - git co -b remix_live origin/remix_live
- - git reset --hard -master-commit-hash- (or remix_beta-commit-hash-)
- - git push -f origin remix_live
+### Part 2. Update the Remix Live
- CircleCI will build automaticaly and remix.ethereum.org will be updated
+Updating the `remix_live` branch latest to the `remix_beta` runs the CircleCI build which updates liver version of Remix IDE on `remix.ethereum.org`
-## Remix IDE release Part 5. Update Zip in release
- - after remix_live is updated, drop the zip (from https://github.com/ethereum/remix-live/) to the release.
+ - `git checkout remix_live`
+ - `git pull origin remix_live`
+ - `git reset --hard ` or `` sometimes
+ - `git push -f origin remix_live`
+
+ CircleCI will build automaticaly and remix.ethereum.org will be updated to the latest.
+
+ ### Part 3. Upload zip file in GitHub release
+ - Once CI is successful for `remix_live` branch, Go to https://github.com/ethereum/remix-live
+ - Download the zip file with the name starting with `remix-`
+ - Upload the zip file in GitHub assets by editing the release for this version
+
+## Bump master branch
+
+ - `git checkout master`
+ - `git pull origin master`
+ - Create a new branch from `master`: `git checkout -b bumpDevVersion`
+ - Bump the package.json version, add the tag `-dev` if not already present.
+ - Create and merge PR to `master`
+
-## Remix-ide beta release
+## Remix IDE Beta Release
- git fetch origin master
- git checkout origin/master
- git checkout -b bumpVersion
- update package.json version to the new version "vx.x.x-beta.1"
- - update version in yarn.lock
- merge PR
- git fetch origin master
- git checkout origin/master
@@ -83,6 +106,6 @@ This is not strictly speaking a release. Updating the remix site is done through
- publish a beta release in github using the changelog
- drop zip file to the beta release (from https://github.com/ethereum/remix-live-alpha)
-## remix-alpha.ethereum.org update
+## Remix IDE Alpha Release
-remix-alpha.ethereum.org is automaticaly updated every time commits are pushed to master
+remix-alpha.ethereum.org is automaticaly updated every time a commit is pushed to `master` branch