Command track-updates

Track the updates.

This command require a `GITHUB_TOKEN` environment variable to be set. It will list all the commits between the `from` and `to` GitHub ref.

The output is in markdown format.

Usage: subalfred track-updates [OPTIONS] --from <VERSION> --to <VERSION> <OWNER/REPOSITORY>

Arguments:
  <OWNER/REPOSITORY>
          Target repository.

          e.g. paritytech/substrate

Options:
      --from <VERSION>
          Release starting from

      --to <VERSION>
          Release updating to

  -l, --log <TARGET=LEVEL,*>
          Set a custom log filter.

          This flag is also working with the `RUST_LOG` environment variable. If you use `RUST_LOG`
          simultaneously, this will append `RUST_LOG`'s value after the log.

          [default: info]

  -h, --help
          Print help information (use `-h` for a summary)

Example

We take paritytech/substrate as an example. If you want to track the updates of cumulus just replace the paritytech/substrate with paritytech/cumulus.

The GITHUB_TOKEN API key must have the privilege of the target repository.

This command will list all the commits/pull requests and their labels between polkadot-v0.9.33 and polkadot-v0.9.36. And some commits/pull requests which was under the important/specific labels.

pub enum WatchedLabels {
	/// [https://github.com/paritytech/substrate/labels/B3-apinoteworthy]
	B3Api,
	/// [https://github.com/paritytech/substrate/labels/B5-clientnoteworthy]
	B5Client,
	/// [https://github.com/paritytech/substrate/labels/B7-runtimenoteworthy]
	B7Runtime,
	/// [https://github.com/paritytech/substrate/labels/C7-high%20❗%EF%B8%8F]
	C7High,
	/// [https://github.com/paritytech/substrate/labels/C9-critical%20‼%EF%B8%8F]
	C9Critical,
	/// [https://github.com/paritytech/substrate/labels/E1-runtimemigration]
	E1Runtime,
	/// [https://github.com/paritytech/substrate/labels/E2-databasemigration]
	E2Database,
	/// [https://github.com/paritytech/substrate/labels/E4-newhostfunctions]
	E4NewHostFunctions,
	/// [https://github.com/paritytech/substrate/labels/E5-breaksapi]
	E5BreaksApi,
	/// [https://github.com/paritytech/substrate/labels/E6-transactionversion]
	E6TransactionVersion,
	/// [https://github.com/paritytech/substrate/labels/E7-breaksauthoring]
	E7BreaksAuthoring,
	/// [https://github.com/paritytech/substrate/labels/E8-breakseverything]
	E8BreaksEverything,
	/// [https://github.com/paritytech/substrate/labels/E10-client-update-first%20👀]
	E10ClientUpdateFirst,
	/// [https://github.com/paritytech/substrate/labels/I8-enhancement%20🎁]
	I8Enhancement,
}

Currently, its output is a markdown. You can copy and paste it to create a new issue manually.

There is an open StackExchange question. After paritytech finishes the refactoring of the labels. This command will provide a more professional update list in the future. You can easily focus on specific parts.

Also, there are some discussion about this command here.

Moreover, there will be a GitHub action later, which will check the Polkadot updates and create an issue for that.

export GITHUB_TOKEN=OMITTED
subalfred track-updates paritytech/substrate --from polkadot-v0.9.33 --to polkadot-v0.9.36
# or
GITHUB_TOKEN=OMITTED subalfred track-updates paritytech/substrate --from polkadot-v0.9.33 --to polkadot-v0.9.36

Track updates

repository: paritytech/substrate
commits   : 112
command   : subalfred track-updates paritytech/substrate --from polkadot-v0.9.33 --to polkadot-v0.9.36

https://github.com/paritytech/substrate/compare/polkadot-v0.9.33...polkadot-v0.9.36

All

Watched labels