semantic-release / semantic-release/github

[docs] d78b44a further broke `default` cell of `releasedLabels` in `Options` table

Open
#840 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
534
Forks
150
Avg merge
1m
Merged PRs (30d)
3

Description

It didn't work well before and it got worse after.
https://github.com/semantic-release/github/blame/d78b44ab2d2e1b14ea9368892a278313beaed89e/README.md#L90

before:

Option Description Default
releasedLabels The labels to add to each issue and pull request resolved by the release. Set to false to not add any label. See releasedLabels. ['released<%= nextRelease.channel ? \ on @${nextRelease.channel}` : "" %>']`

after:

Option Description Default
releasedLabels The labels to add to each issue and pull request resolved by the release. Set to false to not add any label. See releasedLabels. ['released<%= nextRelease.channel ? \ on @${nextRelease.channel}` : "" %>']-

The following is closer to what I think is correct, but may need review by someone who can verify the code snippet is correct..

Option Description Default
releasedLabels The labels to add to each issue and pull request resolved by the release. Set to false to not add any label. See releasedLabels. ['released<%= nextRelease.channel ? \` on @\${nextRelease.channel}\` : "" %>']
| Option | Description | Default |
| --- | --- | --- |
| `releasedLabels`      | The [labels](https://help.github.com/articles/about-labels) to add to each issue and pull request resolved by the release. Set to `false` to not add any label. See [releasedLabels](#releasedlabels). | ```['released<%= nextRelease.channel ? \` on @\${nextRelease.channel}\` : "" %>']``` |

Although a <pre lang="js"> tag could be used to give Javascript code highlighting, doing so makes the entire Default column very wide. I see why that wasn't done before.

For reference, here's the code block with Javascript highlighting.

['released<%= nextRelease.channel ? \` on @\${nextRelease.channel}\` : "" %>']

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.

Research direction

Start in README.md around line 90 and inspect the blame for commit d78b44a. Render the options table to compare the releasedLabels default cell with the surrounding documentation and verify the JavaScript example remains readable. Done means the default value is displayed as an intact code span or block without the stray dash or excessive table width.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.