Extract `changelog-check` to separate action

Open
#142 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions
Domain
ci-cd, devops

Research direction

Start by locating the existing changelog-check workflow and reviewing how other repositories consume it. Extract it into a versioned GitHub Action, update the usage model to support v1-style references, and verify that changelog checks still work for both polyrepos and monorepos.

Written by the indexing model from the issue text.

Description

team-core-platform

The changelog-check workflow helps us ensure that changelogs are updated alongside changes in polyrepos and monorepos.

Currently, when we make use of this workflow in other repos we need to pin to a specific commit ID. This is cumbersome because it means that if we want to make a change to the workflow we now need to go through each repo by hand and update the commit ID.

If we extracted this workflow to an action, we could start using version strings such as v1. As long as new changes were backward compatible they would automatically get propagated to all of the repos.

Dominant language
TypeScript
Stars
12
Forks
7
Avg merge
1d 1h
Merged PRs (30d)
10

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MetaMask/github-tools

All issues in MetaMask/github-tools

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.