@eik/semantic-release-config 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitattributes +1 -0
- package/.github/workflows/publish.yml +29 -0
- package/.prettierrc.json +12 -0
- package/CHANGELOG.md +6 -0
- package/CONTRIBUTING.md +11 -0
- package/README.md +32 -0
- package/eslint.config.js +3 -0
- package/lib/config.js +41 -0
- package/package.json +46 -0
- package/release/eik-semantic-release-config-1.0.0.tgz +0 -0
- package/release.config.js +3 -0
package/.gitattributes
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
* text=auto eol=lf
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
name: Publish
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
- alpha
|
|
8
|
+
- beta
|
|
9
|
+
- next
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
publish:
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
|
|
17
|
+
- uses: actions/setup-node@v4
|
|
18
|
+
with:
|
|
19
|
+
node-version: 20
|
|
20
|
+
|
|
21
|
+
- run: npm install
|
|
22
|
+
|
|
23
|
+
- run: npm run lint
|
|
24
|
+
|
|
25
|
+
- run: npx semantic-release
|
|
26
|
+
env:
|
|
27
|
+
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
|
|
28
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
29
|
+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
package/.prettierrc.json
ADDED
package/CHANGELOG.md
ADDED
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Thank you for showing an interest in contributing to Eik 🧡
|
|
4
|
+
|
|
5
|
+
This module is a [shared config for Semantic Release](https://semantic-release.gitbook.io/semantic-release/usage/shareable-configurations). We accept changes that should apply to all repositories in the [eik-lib origanisation](https://github.com/eik-lib).
|
|
6
|
+
|
|
7
|
+
Commits should follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) format.
|
|
8
|
+
|
|
9
|
+
A change in configuration is considered a `patch` in [semantic versioning](https://semver.org/). A new export would be a `minor`. Requiring a new major of `semantic-release` would be a `major`.
|
|
10
|
+
|
|
11
|
+
This repo uses Semantic Release to automate releases whenever changes are merged to the default branch.
|
package/README.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# @eik/semantic-release-config
|
|
2
|
+
|
|
3
|
+
This is a [semantic-release](https://github.com/semantic-release/semantic-release) config to publish Eik modules meant for internal use in the [eik-lib organisation](https://github.com/eik-lib).
|
|
4
|
+
|
|
5
|
+
This configuration is not related to our [semantic release plugin](https://github.com/eik-lib/semantic-release#readme).
|
|
6
|
+
|
|
7
|
+
## Plugins
|
|
8
|
+
|
|
9
|
+
This shareable configuration uses the following plugins:
|
|
10
|
+
|
|
11
|
+
- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer)
|
|
12
|
+
- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator)
|
|
13
|
+
- [`@semantic-release/changelog`](https://github.com/semantic-release/changelog)
|
|
14
|
+
- [`@semantic-release/npm`](https://github.com/semantic-release/npm)
|
|
15
|
+
- [`@semantic-release/github`](https://github.com/semantic-release/github)
|
|
16
|
+
- [`@semantic-release/git`](https://github.com/semantic-release/git)
|
|
17
|
+
|
|
18
|
+
## Install
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm install --save-dev semantic-release @eik/semantic-release-config
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
In the [semantic-release configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):
|
|
27
|
+
|
|
28
|
+
```json
|
|
29
|
+
{
|
|
30
|
+
"extends": "@eik/semantic-release-config"
|
|
31
|
+
}
|
|
32
|
+
```
|
package/eslint.config.js
ADDED
package/lib/config.js
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @type {Partial<import('semantic-release').GlobalConfig>}
|
|
3
|
+
*/
|
|
4
|
+
export default {
|
|
5
|
+
preset: "angular",
|
|
6
|
+
branches: [
|
|
7
|
+
{
|
|
8
|
+
name: "main",
|
|
9
|
+
},
|
|
10
|
+
{
|
|
11
|
+
name: "alpha",
|
|
12
|
+
prerelease: true,
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
name: "beta",
|
|
16
|
+
prerelease: true,
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
name: "next",
|
|
20
|
+
prerelease: true,
|
|
21
|
+
},
|
|
22
|
+
],
|
|
23
|
+
plugins: [
|
|
24
|
+
"@semantic-release/commit-analyzer",
|
|
25
|
+
"@semantic-release/release-notes-generator",
|
|
26
|
+
"@semantic-release/changelog",
|
|
27
|
+
[
|
|
28
|
+
"@semantic-release/npm",
|
|
29
|
+
{
|
|
30
|
+
tarballDir: "release",
|
|
31
|
+
},
|
|
32
|
+
],
|
|
33
|
+
[
|
|
34
|
+
"@semantic-release/github",
|
|
35
|
+
{
|
|
36
|
+
assets: "release/*.tgz",
|
|
37
|
+
},
|
|
38
|
+
],
|
|
39
|
+
"@semantic-release/git",
|
|
40
|
+
],
|
|
41
|
+
};
|
package/package.json
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@eik/semantic-release-config",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Shared semantic release config used in Eik modules",
|
|
5
|
+
"exports": {
|
|
6
|
+
".": {
|
|
7
|
+
"default": "./lib/config.js"
|
|
8
|
+
}
|
|
9
|
+
},
|
|
10
|
+
"type": "module",
|
|
11
|
+
"keywords": [
|
|
12
|
+
"semantic-release",
|
|
13
|
+
"semantic-release-config"
|
|
14
|
+
],
|
|
15
|
+
"repository": {
|
|
16
|
+
"type": "git",
|
|
17
|
+
"url": "git+ssh://git@github.com/eik-lib/semantic-release-config.git"
|
|
18
|
+
},
|
|
19
|
+
"publishConfig": {
|
|
20
|
+
"access": "public"
|
|
21
|
+
},
|
|
22
|
+
"bugs": {
|
|
23
|
+
"url": "https://github.com/eik-lib/semantic-release-config/issues"
|
|
24
|
+
},
|
|
25
|
+
"homepage": "https://github.com/eik-lib/semantic-release-config#readme",
|
|
26
|
+
"author": "",
|
|
27
|
+
"license": "MIT",
|
|
28
|
+
"scripts": {
|
|
29
|
+
"lint": "eslint .",
|
|
30
|
+
"lint:fix": "npm run lint -- --fix",
|
|
31
|
+
"test": "echo \"Error: no test specified\" && exit 1"
|
|
32
|
+
},
|
|
33
|
+
"devDependencies": {
|
|
34
|
+
"@eik/eslint-config": "1.0.0",
|
|
35
|
+
"eslint": "9.8.0",
|
|
36
|
+
"semantic-release": "24.0.0"
|
|
37
|
+
},
|
|
38
|
+
"dependencies": {
|
|
39
|
+
"@semantic-release/changelog": "6.0.3",
|
|
40
|
+
"@semantic-release/commit-analyzer": "13.0.0",
|
|
41
|
+
"@semantic-release/git": "10.0.1",
|
|
42
|
+
"@semantic-release/github": "10.1.3",
|
|
43
|
+
"@semantic-release/npm": "12.0.1",
|
|
44
|
+
"@semantic-release/release-notes-generator": "14.0.1"
|
|
45
|
+
}
|
|
46
|
+
}
|
|
Binary file
|