Skip to content

Commit

Permalink
upgrade dependencies + update docs on releasing (#315)
Browse files Browse the repository at this point in the history
* outlines full process for releasing (not jus the technical part)

* upgrades mento and oclif dependencies as these had subdeps that were
giving warnings on install

* test package install with npm intead of yarn as its more generic/
offers better chance to catch bugs

<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on upgrading and fixing dependencies in the project. 

### Detailed summary
- Upgraded `@celo/celocli` and `@celo/odis-identifiers` dependencies
- Fixed an error with `husky` not being installed on initial setup
- Updated various CLI commands with gas currency values and addresses
- Updated various OCLIF plugins and packages to their latest versions

> The following files were skipped due to too many changes:
`docs/command-line-interface/oracle.md`,
`docs/command-line-interface/network.md`, `RELEASE.md`,
`docs/command-line-interface/dkg.md`,
`docs/command-line-interface/exchange.md`,
`docs/command-line-interface/validatorgroup.md`,
`docs/command-line-interface/election.md`,
`docs/command-line-interface/transfer.md`,
`docs/command-line-interface/lockedgold.md`,
`docs/command-line-interface/plugins.md`,
`docs/sdk/contractkit/classes/kit.ContractKit.md`,
`docs/command-line-interface/validator.md`,
`docs/command-line-interface/releasecelo.md`,
`docs/command-line-interface/governance.md`,
`docs/command-line-interface/account.md`, `yarn.lock`

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`

<!-- end pr-codex -->

---------

Co-authored-by: Victoria <[email protected]>
  • Loading branch information
aaronmgdr and lvpeschke authored Aug 8, 2024
1 parent d245703 commit dd67b8f
Show file tree
Hide file tree
Showing 33 changed files with 2,318 additions and 3,535 deletions.
5 changes: 5 additions & 0 deletions .changeset/fluffy-poets-smile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@celo/celocli': patch
---

chore: bump oclif
5 changes: 5 additions & 0 deletions .changeset/mighty-snakes-yell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@celo/contractkit': patch
---

chore (bump deps)
5 changes: 5 additions & 0 deletions .changeset/wise-hounds-join.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@celo/celocli': patch
---

Upgrade mento packages. version before was accidentally trying to use a dev dependency. (fix husky not installed on install error)
8 changes: 4 additions & 4 deletions .github/workflows/cron-npm-install.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ jobs:
run: |
apt update
apt install -y libusb-1.0-0-dev libudev-dev
yarn global add node-gyp
npm install node-gyp --global
- name: Installing npm package
run: yarn add ${{ matrix.package }}
run: npm install ${{ matrix.package }}
- name: Test celocli command
if: matrix.package == '@celo/celocli'
if: matrix.package == '@celo/celocli@beta'
run: |
yarn workspace @celo/celocli run celocli account:new
npm run celocli account:new
50 changes: 27 additions & 23 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Release Process


## What do we mean when we say own a release

Being assigned as the release steward means you are expected to deliver

* 1 or more sets of beta releases.
* The final release of packages.
* Release notes on github for every package (automatically created by changesets bot)
* If the release is significant a forum post with the highlights and link back to release notes

### What is a signicant release

This is intentionally not defined. Some guiding principles: if it has been a long time, if someone will be asking about the release, if there are big fixes.


### What do I do?

As the release steward you should be making sure all prs get the approval they need and have attention that the ci checks are not stuck. This may be automated but its not a passive role. When changesets has published try out installing the new version yourself for each beta and the final. Give celocli a quick spin. Are there people who reported bugs? Message them or comment on their github issue asking them to try the latest beta.


For technical details see below.



## The tools

This repo uses [changesets](https://github.com/changesets/changesets) to determine what
packages need a version bump.

Expand Down Expand Up @@ -31,34 +57,12 @@ Additional labels for pre-release and build metadata are available as extensions

## Production releases

### Automatic (recommended)
### Automatic (only way possible)

The [`release.yaml`](./.github/workflows/release.yaml) workflow will create a PR called
"Version Packages", each time a PR is merged to master with changeset files this PR will be rebased and updated to show what the published versions would be. Merging this PR will build and publish packages to NPM,
and publish GitHub release notes.

### Manual (discouraged)

When it's time to release NPM packages run:

```sh
$ changeset version
```

This will look through the changeset files that have been generated since the last release and
bump package versions automatically.

To publish the relevant NPM packages run:

```sh
$ changeset publish
```

Afterwards, push git tags to GitHub:

```sh
$ git push --follow-tags
```

## Pre-releases

Expand Down
Loading

0 comments on commit dd67b8f

Please sign in to comment.