MetaMask / MetaMask/action-npm-publish

Output too noisy, particularly for monorepos

Open
#95 2 comments 0 reactions 0 assignees View on GitHub
team-wallet-framework wf-release-process
Dominant language
Shell
Stars
8
Forks
9
PR merge metrics
No merged PRs in 30d

Description

As an NPM admin, it is my job to review the dry-run output for a project in order to approve a release. However, the output for this action is too noisy. This is mainly due to the fact that `+x` is still enabled, but the output is also a bit disorganized. This is not a huge deal for libraries, but for monorepos, which could contain many packages, it makes review unnecessarily difficult. One must have knowledge of what is important and what is not, and details could be missed.

Ideally, the output should make it very clear what actions are about to be performed (or not performed) and which packages are being published and which are not. And all actions should be grouped by package if possible instead of being divided up. Finally, the output should provide instructions to assist the reviewer.

Because this action has additional steps after the "Dry Run Publish" step, perhaps it makes more sense to provide a step at the very end which summarizes what happened instead of trying to clean up `scripts/publish.sh` or `scripts/report.sh`. Then we would ask people to look at this step instead of "Dry Run Publish" during review. This would allow us to create the output we want.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading scripts/publish.sh and scripts/report.sh, then trace the GitHub Action steps after "Dry Run Publish". Define the final review output around grouped package actions, publish decisions, and reviewer instructions; done means the dry-run workflow presents a clear end-of-action summary.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, shell
Domain
ci-cd, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.