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: update file extensions to include .mjs on configuration docs page #3322

Conversation

dustin-ruetz
Copy link
Contributor

@dustin-ruetz dustin-ruetz commented May 29, 2024

Issue

Resolves #3323

Thought Process

  • I edited the docs/usage/configuration.md file to 1) ensure that the .mjs file extension is mentioned alongside .cjs, and 2) included a release.config.mjs example code snippet demonstrating the export default {} ES Module syntax.
  • I did a codebase search for the .cjs file extension to ensure that I hadn't missed any other related documentation.
  • I added two new unit tests to the test/get-config.test.js file to ensure that reading options from .mjs files are covered.

@travi travi changed the title Update file extensions to include .mjs on configuration docs page docs: update file extensions to include .mjs on configuration docs page May 29, 2024
@travi travi merged commit 2620c10 into semantic-release:master May 29, 2024
6 checks passed
@travi
Copy link
Member

travi commented May 29, 2024

thanks, @dustin-ruetz!

@dustin-ruetz dustin-ruetz deleted the update-file-extensions-on-configuration-docs-page branch May 29, 2024 12:12
Copy link

🎉 This PR is included in version 24.0.0 🎉

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.

Update file extensions to include .mjs on configuration docs page
2 participants