mirror of
https://github.com/scratchfoundation/scratch-semantic-release-config.git
synced 2025-02-17 00:20:29 -05:00
refactor: fork from @jedmao/semantic-release-npm-github-config@1.0.9
* Update repository references * Update `package-lock.json` * Rename `.releaserc.json` to `release.config.js` * A few other minor tweaks
This commit is contained in:
Christopher Willis-Ford
parent
121e8b242b
commit
e4e298f073
7 changed files with 17791 additions and 3548 deletions
30
.github/workflows/master.yml
vendored
30
.github/workflows/master.yml
vendored
|
|
@ -1,30 +0,0 @@
|
|||
name: Node CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
|
||||
jobs:
|
||||
release:
|
||||
name: npm publish / GitHub release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v1
|
||||
- name: Setup Node
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 12
|
||||
registry-url: https://registry.npmjs.org/
|
||||
- name: Install
|
||||
env:
|
||||
CI: true
|
||||
run: npm ci
|
||||
- name: Semantic Release
|
||||
if: success()
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GH_TOKEN }}
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
run: npx semantic-release
|
||||
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -1 +1 @@
|
|||
node_modules
|
||||
/node_modules
|
||||
|
|
|
|||
82
CHANGELOG.md
82
CHANGELOG.md
|
|
@ -1,82 +0,0 @@
|
|||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file. See
|
||||
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## [1.0.9](https://github.com/jedmao/semantic-release-npm-github-config/compare/v1.0.8...v1.0.9) (2019-12-02)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* update dependencies, audit fix ([4f07b55](https://github.com/jedmao/semantic-release-npm-github-config/commit/4f07b55022212a4d3c721219a805c949857ef7ae))
|
||||
|
||||
## [1.0.8](https://github.com/jedmao/semantic-release-npm-github-config/compare/v1.0.7...v1.0.8) (2019-11-03)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* update dependencies (security fixes) ([acaeeb6](https://github.com/jedmao/semantic-release-npm-github-config/commit/acaeeb69a87bc12c72e1650559a594a123eecbf4))
|
||||
|
||||
## [1.0.7](https://github.com/jedmao/semantic-release-npm-github-config/compare/v1.0.6...v1.0.7) (2019-09-25)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* place tarball in a separate pack dir ([8d609a7](https://github.com/jedmao/semantic-release-npm-github-config/commit/8d609a7))
|
||||
|
||||
## [1.0.6](https://github.com/jedmao/semantic-release-npm-github-config/compare/v1.0.5...v1.0.6) (2019-06-26)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* broken badges ([2aead16](https://github.com/jedmao/semantic-release-npm-github-config/commit/2aead16))
|
||||
|
||||
## [1.0.5](https://github.com/jedmao/semantic-release-npm-github-config/compare/v1.0.4...v1.0.5) (2019-06-26)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* broken build badge ([a853fe3](https://github.com/jedmao/semantic-release-npm-github-config/commit/a853fe3))
|
||||
|
||||
## [1.0.4](https://github.com/jedmao/semantic-release-npm-github-config/compare/v1.0.3...v1.0.4) (2019-06-11)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* release notes after changelog title ([2dd093c](https://github.com/jedmao/semantic-release-npm-github-config/commit/2dd093c))
|
||||
|
||||
## [1.0.3](https://github.com/jedmao/semantic-release-npm-github-config/compare/v1.0.2...v1.0.3) (2019-06-11)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add notes after title ([e97d855](https://github.com/jedmao/semantic-release-npm-github-config/commit/e97d855))
|
||||
|
||||
## [1.0.2](https://github.com/jedmao/semantic-release-npm-github-config/compare/v1.0.1...v1.0.2) (2019-06-11)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add # before Changelog title ([9c6dd04](https://github.com/jedmao/semantic-release-npm-github-config/commit/9c6dd04))
|
||||
|
||||
## [1.0.1](https://github.com/jedmao/semantic-release-npm-github-config/compare/v1.0.0...v1.0.1) (2019-06-11)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add changelog keyword ([1275b21](https://github.com/jedmao/semantic-release-npm-github-config/commit/1275b21))
|
||||
* add release keyword ([2ca61a0](https://github.com/jedmao/semantic-release-npm-github-config/commit/2ca61a0))
|
||||
* use own config ([a7c517d](https://github.com/jedmao/semantic-release-npm-github-config/commit/a7c517d))
|
||||
|
||||
# 1.0.0 (2019-06-11)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add release keyword ([2ca61a0](https://github.com/jedmao/semantic-release-npm-github-config/commit/2ca61a0))
|
||||
* use own config ([a7c517d](https://github.com/jedmao/semantic-release-npm-github-config/commit/a7c517d))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* initial release ([c818259](https://github.com/jedmao/semantic-release-npm-github-config/commit/c818259))
|
||||
36
README.md
36
README.md
|
|
@ -1,19 +1,13 @@
|
|||
# @jedmao/semantic-release-npm-github-config
|
||||
# scratch-semantic-release-config
|
||||
|
||||
[**semantic-release**](https://github.com/semantic-release/semantic-release) shareable config to publish npm packages with [GitHub](https://github.com).
|
||||
[](https://www.npmjs.com/package/scratch-semantic-release-config)
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-disable -->
|
||||
[](https://github.com/jedmao/semantic-release-npm-github-config/actions)
|
||||
[](https://www.npmjs.com/package/@jedmao/semantic-release-npm-github-config)
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- markdownlint-disable commands-show-output -->
|
||||
Remixed from: [@jedmao/semantic-release-npm-github-config](https://github.com/jedmao/semantic-release-npm-github-config)
|
||||
|
||||
## Plugins
|
||||
|
||||
This [shareable configuration](https://github.com/jedmao/semantic-release-npm-github-config/blob/master/.releaserc.json) uses the following plugins:
|
||||
This [shareable configuration](
|
||||
https://github.com/LLK/scratch-semantic-release-config/blob/main/.releaserc.json) uses the following plugins:
|
||||
|
||||
- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer)
|
||||
- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator)
|
||||
|
|
@ -23,7 +17,9 @@ This [shareable configuration](https://github.com/jedmao/semantic-release-npm-gi
|
|||
|
||||
## Summary
|
||||
|
||||
- Provides an informative [git](https://github.com/semantic-release/git) commit message for the release commit that does not trigger continuous integration and conforms to the [conventional commits specification](https://www.conventionalcommits.org/) (e.g., "chore(release): 1.2.3 [skip ci]\n\nnotes").
|
||||
- Provides an informative [git](https://github.com/semantic-release/git) commit message for the release commit that
|
||||
does not trigger continuous integration and conforms to the [conventional commits specification](
|
||||
https://www.conventionalcommits.org/) (e.g., "chore(release): 1.2.3 [skip ci]\n\nnotes").
|
||||
- Creates a tarball that gets uploaded with each [GitHub release](https://github.com/semantic-release/github).
|
||||
- Publishes the same tarball to [npm](https://github.com/semantic-release/npm).
|
||||
- Commits the version change in `package.json`.
|
||||
|
|
@ -32,7 +28,7 @@ This [shareable configuration](https://github.com/jedmao/semantic-release-npm-gi
|
|||
## Install
|
||||
|
||||
```bash
|
||||
$ npm install --save-dev semantic-release @jedmao/semantic-release-npm-github-config
|
||||
npm install --save-dev semantic-release scratch-semantic-release-config
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
|
@ -41,15 +37,17 @@ The shareable config can be configured in the [**semantic-release** configuratio
|
|||
|
||||
```json
|
||||
{
|
||||
"extends": "@jedmao/semantic-release-npm-github-config",
|
||||
"branch": "master"
|
||||
"extends": "scratch-semantic-release-config",
|
||||
"branch": "main"
|
||||
}
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Ensure that your CI configuration has the following **_secret_** environment variables set:
|
||||
- [`GH_TOKEN`](https://github.com/settings/tokens) with [`public_repo`](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) access.
|
||||
|
||||
- [`GH_TOKEN`](https://github.com/settings/tokens) with [`public_repo`](
|
||||
https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) access.
|
||||
- [`NPM_TOKEN`](https://docs.npmjs.com/cli/token)
|
||||
- [`NODE_AUTH_TOKEN`](https://docs.npmjs.com/cli/token)
|
||||
|
||||
|
|
@ -57,7 +55,9 @@ See each [plugin](#plugins) documentation for required installation and configur
|
|||
|
||||
### GitHub workflows
|
||||
|
||||
If you're [configuring a GitHub workflow](https://help.github.com/en/articles/configuring-a-workflow) you might want to do a test build matrix first and then publish only if those tests succeed across all environments. The following will do just that, immediately after something is merged into `master`.
|
||||
If you're [configuring a GitHub workflow](https://help.github.com/en/articles/configuring-a-workflow) you might want
|
||||
to do a test build matrix first and then publish only if those tests succeed across all environments. The following
|
||||
will do just that, immediately after something is merged into `main`.
|
||||
|
||||
```yml
|
||||
name: Node CI
|
||||
|
|
@ -65,7 +65,7 @@ name: Node CI
|
|||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
|
||||
jobs:
|
||||
test:
|
||||
|
|
|
|||
21167
package-lock.json
generated
21167
package-lock.json
generated
File diff suppressed because it is too large
Load diff
18
package.json
18
package.json
|
|
@ -1,10 +1,10 @@
|
|||
{
|
||||
"name": "@jedmao/semantic-release-npm-github-config",
|
||||
"version": "1.0.9",
|
||||
"description": "semantic-release shareable configuration for npm + GitHub",
|
||||
"main": ".releaserc.json",
|
||||
"name": "scratch-semantic-release-config",
|
||||
"version": "0.0.0",
|
||||
"description": "semantic-release shareable configuration for Scratch",
|
||||
"main": "release.config.js",
|
||||
"files": [
|
||||
".releaserc.json"
|
||||
"release.config.js"
|
||||
],
|
||||
"scripts": {
|
||||
"commit": "git-cz",
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/jedmao/semantic-release-npm-github-config.git"
|
||||
"url": "https://github.com/LLK/scratch-semantic-release-config.git"
|
||||
},
|
||||
"keywords": [
|
||||
"semantic-release",
|
||||
|
|
@ -26,12 +26,12 @@
|
|||
"release",
|
||||
"changelog"
|
||||
],
|
||||
"author": "Jed Mao <jedmao@outlook.com>",
|
||||
"author": "Christopher Willis-Ford <7019101+cwillisf@users.noreply.github.com>",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/jedmao/semantic-release-npm-github-config/issues"
|
||||
"url": "https://github.com/LLK/scratch-semantic-release-config/issues"
|
||||
},
|
||||
"homepage": "https://github.com/jedmao/semantic-release-npm-github-config#readme",
|
||||
"homepage": "https://github.com/LLK/scratch-semantic-release-config#readme",
|
||||
"config": {
|
||||
"commitizen": {
|
||||
"path": "cz-conventional-changelog"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
{
|
||||
module.exports = {
|
||||
"plugins": [
|
||||
"@semantic-release/commit-analyzer",
|
||||
"@semantic-release/release-notes-generator",
|
||||
|
|
@ -27,4 +27,4 @@
|
|||
}
|
||||
]
|
||||
]
|
||||
}
|
||||
};
|
||||
Loading…
Reference in a new issue