Merge pull request #37 from Gepetto/release

Release

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+
+updates:
+
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+      interval: "monthly"
+- package-ecosystem: "pip"
+  directory: "/"
+  schedule:
+      interval: "monthly"

.github/workflows/release.yml

@@ -0,0 +1,22 @@
+name: Release on GitHub & PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: pipx install poetry
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+          cache: poetry
+      - run: poetry publish --build -u __token__ -p ${{ secrets.PYPI_TOKEN }}
+      - run: echo "TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+      - run: gh release create -t "Release ${{ env.TAG}}" -n "$(awk '/## \[${{ env.TAG }}] - /{flag=1;next}/## \[/{flag=0}flag' CHANGELOG.md)" ${{ env.TAG }} dist/*
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,14 +1,21 @@
 # Gepetuto
 
+[![PyPI version](https://badge.fury.io/py/gepetuto.svg)](https://pypi.org/project/gepetuto)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/gepetto/gepetuto/main.svg)](https://results.pre-commit.ci/latest/github/gepetto/gepetuto/main)
+[![Tests](https://github.com/gepetto/gepetuto/actions/workflows/tests.yml/badge.svg)](https://github.com/gepetto/gepetuto/actions/workflows/tests.yml)
+[![Release](https://github.com/gepetto/gepetuto/actions/workflows/release.yml/badge.svg)](https://github.com/gepetto/gepetuto/actions/workflows/release.yml)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)
+
 ## Tutorial edition framework
 
 This project contains some tools to help authoring and maintaing python tutorials presented on notebooks.
 
 ## Install
 
-Until the first release of this package, here is the recommended installation procedure:
+You are strongly encouraged to use a virtual env or similar.
 ```
-pipx install -e .
+python -m pip install gepetuto
 ```
 
 ## Usage
@@ -27,7 +34,7 @@ pipx install -e .
 ## CI Example
 
 example of CI using all gepetuto actions on tests folder here :
-- https://github.com/Gepetto/gepetuto/blob/main/.github/workflows/python-app.yml
+- https://github.com/Gepetto/gepetuto/blob/main/.github/workflows/tests.yml
 
 ## Examples
 

docs/release.md

@@ -0,0 +1,18 @@
+# Publish a cmeel release
+
+A github actions handle the build of the release archives, and push them to PyPI and Github Releases.
+To trigger it, we just need to:
+
+1. use poetry to update the version number
+2. update the changelog
+3. `git commit`
+4. `git tag`
+5. `git push`
+6. `git push --tags`
+
+
+For this, an helper script is provided:
+
+```bash
+./docs/release.sh [patch|minor|major|x.y.z]
+```

docs/release.sh

@@ -0,0 +1,22 @@
+#!/bin/bash -eux
+# ./docs/release.sh [patch|minor|major|x.y.z]
+
+[[ $(basename "$PWD") == docs ]] && cd ..
+
+
+OLD=$(poetry version -s)
+
+poetry version "$1"
+
+NEW=$(poetry version -s)
+DATE=$(date +%Y-%m-%d)
+
+sed -i "/^## \[Unreleased\]/a \\\n## [v$NEW] - $DATE" CHANGELOG.md
+sed -i "/^\[Unreleased\]/s/$OLD/$NEW/" CHANGELOG.md
+sed -i "/^\[Unreleased\]/a [v$NEW]: https://github.com/cmake-wheel/cmeel/compare/v$OLD...v$NEW" CHANGELOG.md
+
+git add pyproject.toml CHANGELOG.md
+git commit -m "Release v$NEW"
+git tag -s "v$NEW" -m "Release v$NEW"
+git push
+git push --tags