algolia / algolia/shipjs

Comment on the issues and PRs after release

Open
#746 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
776
Forks
27
PR merge metrics
No merged PRs in 30d

Description

```
// ship.js.config
{
commentOnGitHubAfterRelease: true, // this name is totally temporary
}
```

With `commentOnGitHubAfterRelease: true`, at the end of `yarn release:trigger`, Ship.js will go to all the related PRs and leave comments like `This PR is included in the recent release vx.y.z`.

It seems semantic-release does this, too.

example: https://github.com/downshift-js/downshift/pull/971#issuecomment-599040696

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing the yarn release:trigger flow and the ship.js.config option commentOnGitHubAfterRelease. Identify how the release finds related PRs, then compare the requested behavior with the linked Downshift example and semantic-release; done means each related PR receives a versioned release comment.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.