From 6bfe2b15cf682bd599e8870758b726c9142b5e39 Mon Sep 17 00:00:00 2001 From: phil-bell Date: Tue, 1 Mar 2022 14:50:33 +0000 Subject: [PATCH 01/11] setting version in main and allowing it to be displayed --- legl_dev/main.py | 9 ++++++++- setup.py | 3 ++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/legl_dev/main.py b/legl_dev/main.py index a66a092..9c9346a 100755 --- a/legl_dev/main.py +++ b/legl_dev/main.py @@ -5,7 +5,9 @@ from legl_dev.command import Command, Steps -app = typer.Typer() +__version__ = "1.0.5" + +app = typer.Typer(invoke_without_command=True) @app.command(help="Start the dev enviroment") @@ -224,6 +226,11 @@ def jstest(): ) steps.run() +@app.callback() +def main(version: bool = False): + if version: + typer.echo(f"v{__version__}") + raise typer.Exit() if __name__ == "__main__": app() diff --git a/setup.py b/setup.py index cdbeeba..73d6798 100644 --- a/setup.py +++ b/setup.py @@ -1,5 +1,6 @@ # -*- coding: utf-8 -*- from setuptools import setup +from legl_dev.main import __version__ packages = ["legl_dev"] @@ -11,7 +12,7 @@ setup_kwargs = { "name": "legl-dev", - "version": "1.0.4", + "version": __version__, "description": "", "long_description": '# `legl-dev`\n\n**Usage**:\n\n```console\n$ legl-dev [OPTIONS] COMMAND [ARGS]...\n```\n\n**Options**:\n\n* `--install-completion`: Install completion for the current shell.\n* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.\n* `--help`: Show this message and exit.\n\n**Commands**:\n\n* `build`: Rebuild the local enviroment\n* `cypress`: Open Cpyress e2e tests\n* `factories`: Clean out and create new factories\n* `format`: Format the code with black and prettier\n* `gitclean`: Cleans out git branches\n* `jstest`: Run JS unit tests\n* `migrate`: Create and run migrations\n* `pytest`: Run the local pytest unit tests\n* `start`: Start the dev enviroment\n* `update`: Update dependancies\n\n## `legl-dev build`\n\nRebuild the local enviroment\n\n**Usage**:\n\n```console\n$ legl-dev build [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--create-db / --no-create-db`: Drop the database and create a fresh one [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev cypress`\n\nOpen Cpyress e2e tests\n\n**Usage**:\n\n```console\n$ legl-dev cypress [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: True]\n* `--help`: Show this message and exit.\n\n## `legl-dev factories`\n\nClean out and create new factories\n\n**Usage**:\n\n```console\n$ legl-dev factories [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev format`\n\nFormat the code with black and prettier\n\n**Usage**:\n\n```console\n$ legl-dev format [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--push / --no-push`: Also push the changes to the repo [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev gitclean`\n\nCleans out git branches\n\n**Usage**:\n\n```console\n$ legl-dev gitclean [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev jstest`\n\nRun JS unit tests\n\n**Usage**:\n\n```console\n$ legl-dev jstest [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: True]\n* `--help`: Show this message and exit.\n\n## `legl-dev migrate`\n\nCreate and run migrations\n\n**Usage**:\n\n```console\n$ legl-dev migrate [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--merge / --no-merge`: Run a migration merge first [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev pytest`\n\nRun the local pytest unit tests\n\n**Usage**:\n\n```console\n$ legl-dev pytest [OPTIONS] [PATH]\n```\n\n**Arguments**:\n\n* `[PATH]`: path for specific test in the format "::::" [default: ]\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--full-diff / --no-full-diff`: Show full diff in errors [default: False]\n* `--create-db / --no-create-db`: Recreates the test database [default: False]\n* `--last-failed / --no-last-failed`: Run the last failed tests [default: False]\n* `--warnings / --no-warnings`: Toggle warnings in output [default: True]\n* `--gui / --no-gui`: Toggle the output gui [default: True]\n* `--help`: Show this message and exit.\n\n## `legl-dev start`\n\nStart the dev enviroment\n\n**Usage**:\n\n```console\n$ legl-dev start [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: True]\n* `--help`: Show this message and exit.\n\n## `legl-dev update`\n\nUpdate dependancies\n\n**Usage**:\n\n```console\n$ legl-dev update [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--help`: Show this message and exit.\n', "author": "phil-bell", From 6e8f97f5118cef02dc7648e7f7bfc4790771725e Mon Sep 17 00:00:00 2001 From: phil-bell Date: Tue, 1 Mar 2022 14:56:43 +0000 Subject: [PATCH 02/11] setting enviroment variables for buildkit --- legl_dev/main.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/legl_dev/main.py b/legl_dev/main.py index 9c9346a..41e11b4 100755 --- a/legl_dev/main.py +++ b/legl_dev/main.py @@ -1,6 +1,5 @@ #!/usr/bin/env python3 -from os import environ - +import os import typer from legl_dev.command import Command, Steps @@ -9,6 +8,8 @@ app = typer.Typer(invoke_without_command=True) +os.environ["COMPOSE_DOCKER_CLI_BUILD"] = "1" +os.environ["DOCKER_BUILDKIT"] = "1" @app.command(help="Start the dev enviroment") def start(): @@ -46,8 +47,6 @@ def build( ) steps.run() - print("Build complete 🚀") - @app.command(help="Run the local pytest unit tests") def pytest( From c93e252e478468ff166d6d99ccc95f3f83cd8e33 Mon Sep 17 00:00:00 2001 From: phil-bell Date: Tue, 1 Mar 2022 16:54:23 +0000 Subject: [PATCH 03/11] setting version in setup.py --- legl_dev/main.py | 55 +++++++++++++++++++++++++++++++++++++----------- pyproject.toml | 6 ++++++ setup.py | 3 +-- 3 files changed, 50 insertions(+), 14 deletions(-) create mode 100644 pyproject.toml diff --git a/legl_dev/main.py b/legl_dev/main.py index 41e11b4..ffaf444 100755 --- a/legl_dev/main.py +++ b/legl_dev/main.py @@ -1,16 +1,17 @@ #!/usr/bin/env python3 import os + +import pkg_resources import typer from legl_dev.command import Command, Steps -__version__ = "1.0.5" - app = typer.Typer(invoke_without_command=True) os.environ["COMPOSE_DOCKER_CLI_BUILD"] = "1" os.environ["DOCKER_BUILDKIT"] = "1" + @app.command(help="Start the dev enviroment") def start(): steps = Steps() @@ -39,9 +40,17 @@ def build( [ Command(command=f"docker compose up -d"), Command(command=(f"docker compose exec backend python manage.py migrate")), - Command(command=(f"docker compose exec backend python manage.py flush --noinput")), - Command(command=(f"docker compose exec backend python manage.py run_factories")), - Command(command=(f"docker compose exec backend python manage.py seed_emails")), + Command( + command=( + f"docker compose exec backend python manage.py flush --noinput" + ) + ), + Command( + command=(f"docker compose exec backend python manage.py run_factories") + ), + Command( + command=(f"docker compose exec backend python manage.py seed_emails") + ), Command(command=f"docker compose stop"), ] ) @@ -156,19 +165,31 @@ def cypress(): def migrate( merge: bool = typer.Option(False, help="Run a migration merge first"), make: bool = typer.Option(False, help="Run makemigrations before migrating"), - run: bool = typer.Option(True, help="use --no-run to prevent migrations from running"), + run: bool = typer.Option( + True, help="use --no-run to prevent migrations from running" + ), ): steps = Steps() if merge: steps.add( Command( - command=(f"docker compose " "exec backend python manage.py makemigrations --merge") + command=( + f"docker compose " + "exec backend python manage.py makemigrations --merge" + ) ), ) if make: steps.add( - (Command(command=(f"docker compose " "exec backend python manage.py makemigrations"))), + ( + Command( + command=( + f"docker compose " + "exec backend python manage.py makemigrations" + ) + ) + ), ) if run: steps.add( @@ -184,13 +205,21 @@ def factories( steps = Steps( steps=[ - Command(command=(f"docker compose exec backend python manage.py flush --noinput")), - Command(command=(f"docker compose exec backend python manage.py run_factories")), + Command( + command=( + f"docker compose exec backend python manage.py flush --noinput" + ) + ), + Command( + command=(f"docker compose exec backend python manage.py run_factories") + ), ], ) if emails: steps.add( - Command(command=(f"docker compose exec backend python manage.py seed_emails")), + Command( + command=(f"docker compose exec backend python manage.py seed_emails") + ), ) steps.run() @@ -225,11 +254,13 @@ def jstest(): ) steps.run() + @app.callback() def main(version: bool = False): if version: - typer.echo(f"v{__version__}") + typer.echo(f"v{pkg_resources.require('legl_dev')[0].version}") raise typer.Exit() + if __name__ == "__main__": app() diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..374b58c --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,6 @@ +[build-system] +requires = [ + "setuptools>=42", + "wheel" +] +build-backend = "setuptools.build_meta" diff --git a/setup.py b/setup.py index 73d6798..f93eab8 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,5 @@ # -*- coding: utf-8 -*- from setuptools import setup -from legl_dev.main import __version__ packages = ["legl_dev"] @@ -12,7 +11,7 @@ setup_kwargs = { "name": "legl-dev", - "version": __version__, + "version": "1.0.5", "description": "", "long_description": '# `legl-dev`\n\n**Usage**:\n\n```console\n$ legl-dev [OPTIONS] COMMAND [ARGS]...\n```\n\n**Options**:\n\n* `--install-completion`: Install completion for the current shell.\n* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.\n* `--help`: Show this message and exit.\n\n**Commands**:\n\n* `build`: Rebuild the local enviroment\n* `cypress`: Open Cpyress e2e tests\n* `factories`: Clean out and create new factories\n* `format`: Format the code with black and prettier\n* `gitclean`: Cleans out git branches\n* `jstest`: Run JS unit tests\n* `migrate`: Create and run migrations\n* `pytest`: Run the local pytest unit tests\n* `start`: Start the dev enviroment\n* `update`: Update dependancies\n\n## `legl-dev build`\n\nRebuild the local enviroment\n\n**Usage**:\n\n```console\n$ legl-dev build [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--create-db / --no-create-db`: Drop the database and create a fresh one [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev cypress`\n\nOpen Cpyress e2e tests\n\n**Usage**:\n\n```console\n$ legl-dev cypress [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: True]\n* `--help`: Show this message and exit.\n\n## `legl-dev factories`\n\nClean out and create new factories\n\n**Usage**:\n\n```console\n$ legl-dev factories [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev format`\n\nFormat the code with black and prettier\n\n**Usage**:\n\n```console\n$ legl-dev format [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--push / --no-push`: Also push the changes to the repo [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev gitclean`\n\nCleans out git branches\n\n**Usage**:\n\n```console\n$ legl-dev gitclean [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev jstest`\n\nRun JS unit tests\n\n**Usage**:\n\n```console\n$ legl-dev jstest [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: True]\n* `--help`: Show this message and exit.\n\n## `legl-dev migrate`\n\nCreate and run migrations\n\n**Usage**:\n\n```console\n$ legl-dev migrate [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--merge / --no-merge`: Run a migration merge first [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev pytest`\n\nRun the local pytest unit tests\n\n**Usage**:\n\n```console\n$ legl-dev pytest [OPTIONS] [PATH]\n```\n\n**Arguments**:\n\n* `[PATH]`: path for specific test in the format "::::" [default: ]\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--full-diff / --no-full-diff`: Show full diff in errors [default: False]\n* `--create-db / --no-create-db`: Recreates the test database [default: False]\n* `--last-failed / --no-last-failed`: Run the last failed tests [default: False]\n* `--warnings / --no-warnings`: Toggle warnings in output [default: True]\n* `--gui / --no-gui`: Toggle the output gui [default: True]\n* `--help`: Show this message and exit.\n\n## `legl-dev start`\n\nStart the dev enviroment\n\n**Usage**:\n\n```console\n$ legl-dev start [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: True]\n* `--help`: Show this message and exit.\n\n## `legl-dev update`\n\nUpdate dependancies\n\n**Usage**:\n\n```console\n$ legl-dev update [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--help`: Show this message and exit.\n', "author": "phil-bell", From 0797880ab72f56eba34a3784161c56ed19e8eb57 Mon Sep 17 00:00:00 2001 From: phil-bell Date: Tue, 1 Mar 2022 16:57:53 +0000 Subject: [PATCH 04/11] testing releases --- .github/workflows/release.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..045968c --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,19 @@ +name: release + +on: push + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Build + run: | + python3 -m pip install --upgrade build + python3 -m build + - name: Release + uses: softprops/action-gh-release@v1 + with: + files: dist/* + token: ${{ secrets.GITHUB_TOKEN }} From 32d44fc4ca6e39a06ff505ab647501de54fac1ee Mon Sep 17 00:00:00 2001 From: phil-bell Date: Tue, 1 Mar 2022 17:06:26 +0000 Subject: [PATCH 05/11] adding tag_name --- .github/workflows/release.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 045968c..5bf2b9f 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -17,3 +17,4 @@ jobs: with: files: dist/* token: ${{ secrets.GITHUB_TOKEN }} + tag_name: python3 setup.py --version From db7710e2617d170978fcb5ac7604c4012846e514 Mon Sep 17 00:00:00 2001 From: phil-bell Date: Tue, 1 Mar 2022 17:10:28 +0000 Subject: [PATCH 06/11] trying stating tag name --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 5bf2b9f..06db27a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -17,4 +17,4 @@ jobs: with: files: dist/* token: ${{ secrets.GITHUB_TOKEN }} - tag_name: python3 setup.py --version + tag_name: 1.0.5 From c91e78bd50340b1a0dc635a40ca24974aa784643 Mon Sep 17 00:00:00 2001 From: phil-bell Date: Tue, 1 Mar 2022 17:19:16 +0000 Subject: [PATCH 07/11] trying to pass version to github env --- .github/workflows/release.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 06db27a..7e6e671 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -3,7 +3,7 @@ name: release on: push jobs: - build: + release: runs-on: ubuntu-latest steps: - name: Checkout @@ -12,9 +12,10 @@ jobs: run: | python3 -m pip install --upgrade build python3 -m build + echo "VERSION=$(python setup.py --version)" >> $GITHUB_ENV - name: Release uses: softprops/action-gh-release@v1 with: files: dist/* token: ${{ secrets.GITHUB_TOKEN }} - tag_name: 1.0.5 + tag_name: ${{ env.VERSION }} From 6dc88bcc789af497d6d1f2390c3fe938a915fddc Mon Sep 17 00:00:00 2001 From: phil-bell Date: Tue, 1 Mar 2022 17:30:19 +0000 Subject: [PATCH 08/11] changing release to only happen on main --- .github/workflows/release.yml | 37 +++++++++++++++++++---------------- setup.py | 2 +- 2 files changed, 21 insertions(+), 18 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 7e6e671..de26d77 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,21 +1,24 @@ name: release -on: push +on: + push: + branches: + - "main" jobs: - release: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v2 - - name: Build - run: | - python3 -m pip install --upgrade build - python3 -m build - echo "VERSION=$(python setup.py --version)" >> $GITHUB_ENV - - name: Release - uses: softprops/action-gh-release@v1 - with: - files: dist/* - token: ${{ secrets.GITHUB_TOKEN }} - tag_name: ${{ env.VERSION }} + release: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Build + run: | + python3 -m pip install --upgrade build + python3 -m build + echo "VERSION=$(python setup.py --version)" >> $GITHUB_ENV + - name: Release + uses: softprops/action-gh-release@v1 + with: + files: dist/* + token: ${{ secrets.GITHUB_TOKEN }} + tag_name: ${{ env.VERSION }} diff --git a/setup.py b/setup.py index f93eab8..fbb1ae5 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ setup_kwargs = { "name": "legl-dev", - "version": "1.0.5", + "version": "1.0.6", "description": "", "long_description": '# `legl-dev`\n\n**Usage**:\n\n```console\n$ legl-dev [OPTIONS] COMMAND [ARGS]...\n```\n\n**Options**:\n\n* `--install-completion`: Install completion for the current shell.\n* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.\n* `--help`: Show this message and exit.\n\n**Commands**:\n\n* `build`: Rebuild the local enviroment\n* `cypress`: Open Cpyress e2e tests\n* `factories`: Clean out and create new factories\n* `format`: Format the code with black and prettier\n* `gitclean`: Cleans out git branches\n* `jstest`: Run JS unit tests\n* `migrate`: Create and run migrations\n* `pytest`: Run the local pytest unit tests\n* `start`: Start the dev enviroment\n* `update`: Update dependancies\n\n## `legl-dev build`\n\nRebuild the local enviroment\n\n**Usage**:\n\n```console\n$ legl-dev build [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--create-db / --no-create-db`: Drop the database and create a fresh one [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev cypress`\n\nOpen Cpyress e2e tests\n\n**Usage**:\n\n```console\n$ legl-dev cypress [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: True]\n* `--help`: Show this message and exit.\n\n## `legl-dev factories`\n\nClean out and create new factories\n\n**Usage**:\n\n```console\n$ legl-dev factories [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev format`\n\nFormat the code with black and prettier\n\n**Usage**:\n\n```console\n$ legl-dev format [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--push / --no-push`: Also push the changes to the repo [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev gitclean`\n\nCleans out git branches\n\n**Usage**:\n\n```console\n$ legl-dev gitclean [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev jstest`\n\nRun JS unit tests\n\n**Usage**:\n\n```console\n$ legl-dev jstest [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: True]\n* `--help`: Show this message and exit.\n\n## `legl-dev migrate`\n\nCreate and run migrations\n\n**Usage**:\n\n```console\n$ legl-dev migrate [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--merge / --no-merge`: Run a migration merge first [default: False]\n* `--help`: Show this message and exit.\n\n## `legl-dev pytest`\n\nRun the local pytest unit tests\n\n**Usage**:\n\n```console\n$ legl-dev pytest [OPTIONS] [PATH]\n```\n\n**Arguments**:\n\n* `[PATH]`: path for specific test in the format "::::" [default: ]\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--full-diff / --no-full-diff`: Show full diff in errors [default: False]\n* `--create-db / --no-create-db`: Recreates the test database [default: False]\n* `--last-failed / --no-last-failed`: Run the last failed tests [default: False]\n* `--warnings / --no-warnings`: Toggle warnings in output [default: True]\n* `--gui / --no-gui`: Toggle the output gui [default: True]\n* `--help`: Show this message and exit.\n\n## `legl-dev start`\n\nStart the dev enviroment\n\n**Usage**:\n\n```console\n$ legl-dev start [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: True]\n* `--help`: Show this message and exit.\n\n## `legl-dev update`\n\nUpdate dependancies\n\n**Usage**:\n\n```console\n$ legl-dev update [OPTIONS]\n```\n\n**Options**:\n\n* `--verbose / --no-verbose`: Run the command in verbose mode [default: False]\n* `--help`: Show this message and exit.\n', "author": "phil-bell", From 6647b1db343fa4f40de54aeca1ed20665c0d3da6 Mon Sep 17 00:00:00 2001 From: phil-bell Date: Tue, 1 Mar 2022 17:36:15 +0000 Subject: [PATCH 09/11] testing descriptions --- .github/workflows/release.yml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index de26d77..fec995e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,9 +1,6 @@ name: release -on: - push: - branches: - - "main" +on: push jobs: release: @@ -19,6 +16,11 @@ jobs: - name: Release uses: softprops/action-gh-release@v1 with: + description: | + ### Install will + ``` + pip install git+https://github.com/CrowdJustice/legl-dev.git@${{ env.VERSION }} + ``` files: dist/* token: ${{ secrets.GITHUB_TOKEN }} tag_name: ${{ env.VERSION }} From c698b4fec9b97538ed3484f0fbef4c4a2e2ee1d8 Mon Sep 17 00:00:00 2001 From: phil-bell Date: Tue, 1 Mar 2022 17:38:24 +0000 Subject: [PATCH 10/11] trying again on release body --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index fec995e..e48f822 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -16,7 +16,7 @@ jobs: - name: Release uses: softprops/action-gh-release@v1 with: - description: | + body: | ### Install will ``` pip install git+https://github.com/CrowdJustice/legl-dev.git@${{ env.VERSION }} From 05a3c1ab929d7e226c46b9a28e83cf10526d83ce Mon Sep 17 00:00:00 2001 From: phil-bell Date: Tue, 1 Mar 2022 17:46:33 +0000 Subject: [PATCH 11/11] restricting release to main --- .github/workflows/release.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e48f822..aa0bf35 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,6 +1,9 @@ name: release -on: push +on: + push: + branches: + - "main" jobs: release: @@ -17,7 +20,7 @@ jobs: uses: softprops/action-gh-release@v1 with: body: | - ### Install will + ### Install with ``` pip install git+https://github.com/CrowdJustice/legl-dev.git@${{ env.VERSION }} ```