Skip to content

Commit 474ef1c

Browse files
authored
Merge pull request #100 from Boehringer-Ingelheim/refactor/streamline-release-process
refactor: streamline release process and update documentation
2 parents 50e5f1a + c922e14 commit 474ef1c

File tree

4 files changed

+7
-18
lines changed

4 files changed

+7
-18
lines changed

.env.example

Lines changed: 0 additions & 2 deletions
This file was deleted.

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ jobs:
3838
- name: Release package to npm and GitHub
3939
env:
4040
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
41-
run: npm run release:ci
41+
run: npm run release

README.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -326,19 +326,11 @@ npm run repair
326326

327327
### Release
328328

329-
Fully automated version management and package publishing via [semantic-release](https://github.com/semantic-release). It bumps the version according to conventional commits, publishes the package to npm and release a new version to GitHub.
329+
> [!IMPORTANT]
330+
> Manual releases are not supported to ensure consistency and security, see: <https://docs.npmjs.com/trusted-publishers>
330331
331-
#### Automatic Release (GitHub Action) [Recommended]
332-
333-
Make sure that the secrets `GITHUB_TOKEN` and `NPM_TOKEN` are available in GitHub repository.
334-
335-
```sh
336-
npm run release:ci
337-
```
338-
339-
#### Manual Release
340-
341-
Make sure that the environment variables `GITHUB_TOKEN` and `NPM_TOKEN` are set or declared in `.env` and a productive build was previously created via `npm run build`.
332+
Releases are automated through GitHub Actions using [semantic-release](https://github.com/semantic-release).
333+
It bumps the version according to conventional commits, publishes the package to npm and release a new version to GitHub.
342334

343335
```sh
344336
npm run release
@@ -357,7 +349,7 @@ Give a ⭐️ if this project helped you!
357349

358350
## License
359351

360-
Copyright © 2025 [Boehringer Ingelheim](https://github.com/boehringer-ingelheim).
352+
Copyright © 2026 [Boehringer Ingelheim](https://github.com/boehringer-ingelheim).
361353
This project is [MIT](https://github.com/boehringer-ingelheim/eslint-config/blob/master/LICENSE) licensed.
362354

363355
## Resources

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@
3131
"types": "index.d.ts",
3232
"scripts": {
3333
"prepare": "husky",
34-
"release": "dotenv -- semantic-release --no-ci",
35-
"release:ci": "semantic-release",
34+
"release": "semantic-release",
3635
"repair": "npx --yes rimraf@6 .git/hooks node_modules package-lock.json && npm install",
3736
"lint": "eslint ."
3837
},

0 commit comments

Comments
 (0)