jeedom-semrel-plugin-config v1.7.0
jeedom-semrel-plugin-config
semantic-release shareable config to publish Jeedom plugins
with master
and beta
branches.
Repository
see https://www.npmjs.com/package/jeedom-semrel-plugin-config
How-to ?
This Semantic-Release configuration is to be used with Github Workflow, and
with the action-for-semancit-release
using the extends
keyword:
https://github.com/marketplace/actions/action-for-semantic-release#extends
Example of command
npx --package=@semantic-release/changelog@6 \
--package=@semantic-release/exec@6 \
--package=@semantic-release/git@10 \
--package=jeedom-semrel-plugin-config@beta \
--package=semantic-release-export-data@1 \
--package=semantic-release@21 \
semantic-release --extends=jeedom-semrel-plugin-config
Branch name convention
Any branch name means for the main / master / stable version of the plugin. beta
is for the specific beta branch.
The main difference is that the plugin update the changelog_beta.md
instead of
changelog.md
Without nodeJS
Using the official Github action action-for-semancit-release
requires to have
the package.json
file that contains nodeJS configuration. Without this file,
for full PHP / python projetcs, you'll have to run npx
commands instead. Here
is an example of complete Github Workflow :
name: Semantic Release
on:
push:
# this step for master only
branches:
- master
# this is to manually trigger the worklow
workflow_dispatch:
inputs:
logLevel:
description: 'Reason'
default: 'Manual launch'
env:
# branch name, short name, e.g. : stable, master ...
# must be beta for the beta plugin version
VERSION_NAME: ${{ github.github.ref_name }}
jobs:
# one single job
release:
name: release
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
# https://github.com/marketplace/actions/setup-node-js-environment
- uses: actions/setup-node@v3
with:
node-version: 18
- name: semantic
run: |
npx --package=@semantic-release/changelog@6 \
--package=@semantic-release/exec@6 \
--package=@semantic-release/git@10 \
--package=semantic-release-export-data@1 \
--package=jeedom-semrel-plugin-config@1 \
--package=semantic-release@21 \
semantic-release --extends=jeedom-semrel-plugin-config
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Display Github summary
if: steps.semantic.outputs.new_release_published == 'true'
run: |
echo "New release : ${{ steps.semantic.outputs.new_release_version }}" >> $GITHUB_STEP_SUMMARY
Example of integration: https://github.com/jeedom/workflows/blob/main/.github/workflows/semantic-release.yml
This configuration also generate a vars.env
file with the new version generated, e.g. : VERSION=v2.3.4
More options
You can override semantic-release configuration with command line options: https://semantic-release.gitbook.io/semantic-release/usage/configuration#configuration-file
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago