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: Add release.config.cjs example with TypeScript definitions on docs/usage/configuration.md #2950

Merged
merged 7 commits into from
Sep 28, 2023

Conversation

aendel
Copy link
Contributor

@aendel aendel commented Sep 11, 2023

Since the Typescript definitions have been introduced here, with pull request 2916.

I have been using the typescript definitions in my semantic release configuration file, using the JSDoc @type tag.

The edit should be something like the following:

- Via `release.config.cjs` file:

```js
/**
 * @type {import('semantic-release').GlobalConfig}
 */
module.exports = {
  "branches": ["master", "next"]
}

I hope this will help typescript users to adopt this amazing library.

@aendel aendel changed the title docs: Add release.config.js example with TypeScript definitions docs: Add release.config.cjs example with TypeScript definitions Sep 22, 2023
@aendel aendel changed the title docs: Add release.config.cjs example with TypeScript definitions docs: Add release.config.cjs example with TypeScript definitions on docs/usage/configuration.md Sep 22, 2023
@seebeen
Copy link
Member

seebeen commented Sep 28, 2023

Nice catch! 💪
@travi - this one is a-OK.

Copy link
Member

@gr2m gr2m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very cool, thank you!

@travi travi enabled auto-merge (squash) September 28, 2023 14:12
@travi travi merged commit b178c18 into semantic-release:master Sep 28, 2023
5 checks passed
@github-actions
Copy link

🎉 This PR is included in version 22.0.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants