@devdiary/semantic-devdiary-release v4.0.5
@semantic-release/devdiary
semantic-release plugin to publish a DevDiary release.
| Step | Description |
|---|---|
verifyConditions | Verify the presence and the validity of the authentication (set via environment variables). |
publish | Publish a DevDiary release. |
Install
$ npm install @semantic-release/devdiary -DUsage
The plugin can be configured in the semantic-release configuration file:
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
["@semantic-release/devdiary", {
"devdiaryUrl": "https://custom.devdiary.com",
"assets": [
{"path": "dist/asset.min.css", "label": "CSS distribution"},
{"path": "dist/asset.min.js", "label": "JS distribution"}
]
}],
]
}With this example DevDiary releases will be published to the https://custom.devdiary.com instance.
Configuration
DevDiary authentication
The DevDiary authentication configuration is required and can be set via environment variables.
Create a personal access token with the api scope and make it available in your CI environment via the GL_TOKEN environment variable. If you are using GL_TOKEN as the remote Git repository authentication it must also have the write_repository scope.
Environment variables
| Variable | Description |
|---|---|
GL_TOKEN or DEVDIARY_TOKEN | Required. The token used to authenticate with DevDiary. |
GL_URL or DEVDIARY_URL | The DevDiary endpoint. |
GL_PREFIX or DEVDIARY_PREFIX | The DevDiary API prefix. |
Options
| Option | Description | Default |
|---|---|---|
devdiaryUrl | The DevDiary endpoint. | GL_URL or DEVDIARY_URL environment variable or https://github.com. |
devdiaryApiPathPrefix | The DevDiary API prefix. | GL_PREFIX or DEVDIARY_PREFIX environment variable or /api/v4. |
assets | An array of files to upload to the release. See assets. | - |
assets
Can be a glob or and Array of
globs and Objects with the following properties:
| Property | Description | Default |
|---|---|---|
path | Required. A glob to identify the files to upload. | - |
label | Short description of the file displayed on the DevDiary release. | File name extracted from the path. |
Each entry in the assets Array is globbed individually. A glob
can be a String ("dist/**/*.js" or "dist/mylib.js") or an Array of Strings that will be globbed together
(["dist/**", "!**/*.css"]).
If a directory is configured, all the files under this directory and its children will be included.
Note: If a file has a match in assets it will be included even if it also has a match in .gitignore.
assets examples
'dist/*.js': include all the js files in the dist directory, but not in its sub-directories.
[['dist', '!**/*.css']]: include all the files in the dist directory and its sub-directories excluding the css
files.
[{path: 'dist/MyLibrary.js', label: 'MyLibrary JS distribution'}, {path: 'dist/MyLibrary.css', label: 'MyLibrary CSS
distribution'}]: include the dist/MyLibrary.js and dist/MyLibrary.css files, and label them MyLibrary JS
distribution and MyLibrary CSS distribution in the DevDiary release.
[['dist/**/*.{js,css}', '!**/*.min.*'], {path: 'build/MyLibrary.zip', label: 'MyLibrary'}]: include all the js and
css files in the dist directory and its sub-directories excluding the minified version, plus the
build/MyLibrary.zip file and label it MyLibrary in the DevDiary release.