thefrontside / actions

Collection of GitHub Actions created by Frontside
5 stars 1 forks source link

Possible New Action: Auto-robotic Deprecation #57

Closed minkimcello closed 4 years ago

minkimcello commented 4 years ago

Context

From this pull request on bigtest, I was removing unused packages from the monorepo and the discussion of deprecating those packages was initiated.

But first to address some of the comments from that pull request:

@taras: should we add a mechanism to release action to somehow deprecate packages?

@cowboyd: what about adding a deprecated flag to the package.json

Solution

Create a new action to deprecate packages.

Approach

taras commented 4 years ago

@minkimcello I think the workflow should be,

  1. create a PR which adds deprecated: true flag to package.json
  2. merge it to master, release action checks for deprecated: true flag and runs npm deprecate

@cowboyd is this what you had in mind?

minkimcello commented 4 years ago

@taras Using deprecate flag on package.json:

  1. Create a PR to deprecate package
  2. Merge it to master to trigger release action to deprecate package
  3. Create another PR to remove packages from repo
  4. Merge to master

Using deprecate action separate from release action:

  1. Create a PR to remove package
  2. Merge to master

The only downside to this is when we want to rename packages. But I don't know how we would approach that.

taras commented 4 years ago

I'm not a big fan of making separate actions. Ultimately, I want everything living in 1 utility... maybe we have different actions but I'm not sure yet.

@cowboyd what do you think?

minkimcello commented 4 years ago

Resolved with #58, #59, and #60.