Skip to content

Commit ab6171d

Browse files
committed
git commit -m "docs: update README with more information"
1 parent 21db76a commit ab6171d

File tree

1 file changed

+9
-22
lines changed

1 file changed

+9
-22
lines changed

README.md

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ A GitHub Action that runs [semantic-release](https://semantic-release.gitbook.io
1515
- **Wait for Checks**: Unlike typical `semantic-release` workflows, this action allows you to explicitly wait for all other GitHub checks to complete before proceeding with the release. This ensures that releases are only published after all tests and quality gates have passed. **Note**: This feature does not wait for disabled workflows.
1616
- **Decoupled Workflow**: By waiting for other checks, this action can run independently of your main CI workflow (which might be triggered by pull requests and merges to `main`). This decoupling reduces the risk of exposing sensitive `semantic-release` tokens in contexts where they are not strictly necessary, a common security concern in open-source projects.
1717
- **Fast Execution**: The action optimizes for speed by caching dependencies, leading to quicker execution times for your release workflow.
18+
- **Simplified for Polyglot Repositories**: Abstracts away the Node.js ecosystem, enabling `semantic-release` usage in non-Node.js projects without requiring a `package.json` or various JavaScript/TypeScript configuration files within your repository.
1819

1920
## Usage
2021

@@ -60,6 +61,10 @@ This workflow is now configured to trigger a release on any commit to `main` (or
6061
- `working-directory` (optional, default: `'.'`) : The directory to search for `semantic-release` configuration files.
6162
- `allow-force-install` (optional, default: `'false'`): If `'true'`, allows the action to overwrite an existing package.json file and forces npm to install dependencies using the `--force` flag. This can be used to resolve conflicting peer dependency issues but should be used with caution as it may lead to a broken installation.
6263

64+
## Outputs
65+
66+
None
67+
6368
### Configuration
6469

6570
This action uses `cosmiconfig` to find your `semantic-release` configuration. It supports the following file formats:
@@ -76,13 +81,12 @@ This action uses `cosmiconfig` to find your `semantic-release` configuration. It
7681

7782
### In Node.js (or related) projects
7883

79-
For JavaScript/TypeScript projects, you typically use an imperative configuration file like `release.config.mjs` or `release.config.js`. When using such a file, all `semantic-release` plugins must be declared as dependencies in your project's `package.json` file.
84+
For JavaScript/TypeScript projects, you typically use an imperative configuration file like `release.config.mjs` or `release.config.js`. When using such a file, all `semantic-release` plugins must be declared as development dependencies in your project's `package.json` file.
8085

8186
**Example `release.config.mjs`:**
8287

8388
```javascript
84-
// release.config.mjs
85-
const config = {
89+
export default {
8690
branches: ['main', { name: 'beta', prerelease: true }],
8791
plugins: [
8892
'@semantic-release/commit-analyzer',
@@ -91,24 +95,6 @@ const config = {
9195
'@semantic-release/github',
9296
],
9397
};
94-
95-
export default config;
96-
```
97-
98-
**Example `package.json` excerpt:**
99-
100-
```json
101-
{
102-
"name": "my-node-app",
103-
"version": "1.0.0",
104-
"devDependencies": {
105-
"semantic-release": "^23.0.0",
106-
"@semantic-release/commit-analyzer": "^12.0.0",
107-
"@semantic-release/release-notes-generator": "^13.0.0",
108-
"@semantic-release/npm": "^12.0.0",
109-
"@semantic-release/github": "^9.0.0"
110-
}
111-
}
11298
```
11399

114100
The action will automatically run `npm install` in your working directory to ensure all these declared dependencies are available for `semantic-release` to function correctly.
@@ -141,6 +127,7 @@ The action will detect the plugins listed in these declarative files, create a t
141127

142128
- **[Semantic Release](https://semantic-release.gitbook.io/semantic-release/):** The automated versioning and package publishing tool this action runs.
143129
- **[Cosmiconfig](https://github.com/cosmiconfig/cosmiconfig):** The universal configuration loader used by this action to find `semantic-release` configurations.
130+
- **[Semantic Versioning (SemVer)](https://semver.org/):** A widely adopted standard for version numbering that your commit messages can help facilitate with automated tools.
144131

145132
## Contributing
146133

@@ -150,4 +137,4 @@ contributions.
150137

151138
## License
152139

153-
Apache License 2.0 © 2024 Mridang Agarwalla
140+
Apache License 2.0 © 2025 Mridang Agarwalla

0 commit comments

Comments
 (0)