Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
BinToss opened this issue May 24, 2024 · 0 comments

Comments

@BinToss
Copy link

BinToss commented May 24, 2024

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}\` : "" %>']
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant