Underline semver API stability.

Signed-off-by: Tobias Wolf <[email protected]>
On-behalf-of: SAP <[email protected]>

Author: NotTheEvilOne

.github/workflows/release.yml

@@ -1,8 +1,7 @@
 name: pre-release
 
 on:
-  push:
-    tags: [ "[0-9]+.[0-9]+.[0-9]+*" ]
+  push: {}
 
 env:
   GIT_CLIFF_VERSION: 2.12.0
@@ -14,61 +13,10 @@ jobs:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       - uses: gardenlinux/python-gardenlinux-lib/.github/actions/setup@main
       - run: make docs
-      - if: ${{ github.ref_name != 'main' }}
-        name: Upload as artifact
-        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # [email protected]
-        with:
-          name: docs
-          path: _build/
-      - if: ${{ github.ref_name == 'main' }}
-        name: Deploy to GitHub Pages
+      - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
         with:
           publish_branch: gh-pages
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: _build
           force_orphan: true
-
-  create-pre-release:
-    if: ${{ github.ref_name == 'main' }}
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-
-    steps:
-    - name: Checkout commit
-      uses: actions/checkout@v6
-      with:
-        sparse-checkout: |
-          cliff.toml
-        sparse-checkout-cone-mode: false
-    - uses: gardenlinux/python-gardenlinux-lib/.github/actions/setup@main
-    - name: Use cargo cache
-      id: cache-cargo
-      uses: actions/cache@v5
-      with:
-        path: |
-          ~/.cargo
-        key: gh-release-${{ runner.os }}-git-cliff-${{ env.GIT_CLIFF_VERSION }}-
-        restore-keys: gh-release-${{ runner.os }}-git-cliff-${{ env.GIT_CLIFF_VERSION }}-${{ hashFiles('~/.cargo/.crates.toml') }}-
-    - name: Install git-cliff
-      if: steps.cache-cargo.outputs.cache-hit != 'true'
-      run: |
-        cargo install git-cliff@${GIT_CLIFF_VERSION}
-    - name: Get the Git tag name
-      id: get-tag-name
-      run: echo "tag-name=${GITHUB_REF/refs\/tags\//}" | tee -a "$GITHUB_OUTPUT"
-    - id: release
-      name: Create changelog and release
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      run: |
-        gl-gh-release create \
-         --repo "python-gardenlinux-lib" \
-         --tag "${{ steps.get-tag-name.outputs.tag-name }}" \
-         --commit "${{ github.sha }}" \
-         --name 'python-gardenlinux-lib v${{ steps.get-tag-name.outputs.tag-name }}' \
-         --latest \
-         --body "
-         $(git-cliff -o - --current)
-         "

README.md

@@ -6,7 +6,7 @@
 # Parse features lib
 
 This library includes tooling to build and distribute [Garden Linux](https://github.com/gardenlinux/gardenlinux).
-It is targeted to Garden Linux developers and not meant for end users.
+It is targeted to Garden Linux developers and not meant for end users. It follows syntax and intention of `Semantic Versioning <https://www.semver.org>` for provided APIs. Each release reflects the intention and expected impact therefore.
 
 Features: