steinwurf-tasker 3.0.6

A tool for handling automated tasks in Steinwurf.

In Steinwurf we have a few general tasks that every developer in Steinwurf needs to carry out once in a while.

For example, Releasing a new version of a project.

Steinwurf Tasker is the tool for automating such tasks.

Installation

Install the steinwurf-tasker tool using pip:

python -m pip install steinwurf-tasker

Alternatively you can also use pipx for the installation (this works in ubuntu 23.04):

pipx install steinwurf-tasker

Setup config

Create a file in your home folder called .steinwurf-tasker.yaml.

Add the following content and modify the values to the

editor: code
resolve_path: /home/username/projects/dependencies
project_paths:
      - /home/username/projects/
release_email:
      host: smtp.emailhost.com
      port: 587
      sender: [e-mail]
      password: release_email_password
      receiver: [e-mail]

tailscale:
      api_key: tskey-123456789
      url: <tailscale api URL, something like: https://api.tailscale.com/api/v2/tailnet/{user}>
      credentials:
            user: common_account_name
            password: common_account_password

Usage

You’ll now be able to use the sw command line tool. The following will list the available sw commands:

sw -l

You can also release a project without a config file by passing the project path directly:

sw project.release myproject --project-path /home/username/projects

Update

To update Steinwurf Tasker use pip:

python -m pip install steinwurf-tasker

Please make sure to also extend the config file with required information.

Development

When developing a new feature for Steinwurf Tasker it can be nice to install the local version in editable mode. This can done using the following command:

cd steinwurf-tasker
python3 -m pip install -e .

To revert this and use the pip package use this command:

cd steinwurf-tasker
python3 -m pip uninstall steinwurf-tasker
python -m pip install steinwurf-tasker

Release

PyPI releases for this repository are published through the GitHub Actions workflow .github/workflows/pypi-publish.yml.

The workflow runs when a *.*.* tag is pushed, and it can also be started manually from the Actions tab using workflow_dispatch.