simplify packaging and publishing

Author: d-biehl

.github/workflows/build.yml

@@ -99,7 +99,7 @@ jobs:
         if: always()
 
   package:
-    #needs: test
+    needs: test
     runs-on: ubuntu-latest
 
     steps:
@@ -129,7 +129,7 @@ jobs:
         run: npm install --also=dev
 
       - name: package
-        run: poetry run npm-package
+        run: poetry run npm package
 
       - name: Upload VSCode package
         uses: actions/upload-artifact@v2
@@ -151,9 +151,8 @@ jobs:
 
   publish:
     runs-on: ubuntu-latest
-    environment: publish
     needs: package
-    if: success() && startsWith( github.ref, 'refs/tags')
+    if: success() && startsWith( github.ref, 'refs/tags/v')
     steps:
       - uses: actions/checkout@v2
         with:
@@ -193,26 +192,23 @@ jobs:
           name: wheel-package
           path: dist
 
-      - name: publish
-        run: poetry run npm-publish
-        env:
-          VSCE_PAT: ${{ secrets.VSCE_PAT }}
-          OVSX_PAT: ${{ secrets.OVSX_PAT }}
-          PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-
       - name: get release notes
         id: get_release_notes
-        run: echo "::set-output name=release_notes::$(poetry run extract-release-notes)"
+        run: echo "::set-output name=release_notes::$(poetry run npm extract-release-notes)"
 
-      - name: find vsix
-        id: find_vsix
+      - name: find assets
+        id: find_assets
         run: |
           echo "::set-output name=vsix_file::$(find dist -iname '*.vsix')"
           echo "::set-output name=vsix_name::$(find dist -iname '*.vsix' -printf '%f\n')"
 
+          echo "::set-output name=whl_file::$(find dist -iname '*.whl')"
+          echo "::set-output name=whl_name::$(find dist -iname '*.whl' -printf '%f\n')"
 
-      - name: create release
+          echo "::set-output name=tar_gz_file::$(find dist -iname '*.tar.gz')"
+          echo "::set-output name=tar_gz_name::$(find dist -iname '*.tar.gz' -printf '%f\n')"
+
+      - name: create github release
         id: create_release
         uses: actions/create-release@v1
         env:
@@ -224,13 +220,44 @@ jobs:
           draft: true
           prerelease: true
 
-      - name: upload release vsix
-        id: upload-release-asset
+      - name: upload vsix asset to github release
+        id: upload-vsix-asset
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
-          asset_path: ${{ steps.find_vsix.outputs.vsix_file }}
-          asset_name: ${{ steps.find_vsix.outputs.vsix_name }}
+          asset_path: ${{ steps.find_assets.outputs.vsix_file }}
+          asset_name: ${{ steps.find_assets.outputs.vsix_name }}
           asset_content_type: application/vsix
+
+      - name: upload whl asset to github release
+        id: upload-whl-asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
+          asset_path: ${{ steps.find_assets.outputs.whl_file }}
+          asset_name: ${{ steps.find_assets.outputs.whl_name }}
+          asset_content_type: application/whl
+
+      - name: upload tar.gz asset to github release
+        id: upload-tar-gz-asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
+          asset_path: ${{ steps.find_assets.outputs.tar_gz_file }}
+          asset_name: ${{ steps.find_assets.outputs.tar_gz_name }}
+          asset_content_type: application/whl
+
+      - name: publish vsix and python packages
+        run: poetry run npm publish
+        env:
+          VSCE_PAT: ${{ secrets.VSCE_PAT }}
+          OVSX_PAT: ${{ secrets.OVSX_PAT }}
+          PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+

README.md

@@ -66,6 +66,7 @@ Autocompletion supports all supported variables types
     - Resources
     - Variables
 - Errors and Warnings
+
 ### Diagnostics and Linting
 
 RobotCode analyse your code and show diagnostics for:

package.json

@@ -648,7 +648,8 @@
     "version": "python scripts/update_versions.py && git add .",
     "package": "python scripts/package.py",
     "publish": "python scripts/publish.py",
-    "package-publish": "npm run package && python scripts/publish.py"
+    "package-publish": "npm run package && python scripts/publish.py",
+    "extract-release-notes": "python scripts/extract_release_notes.py"
   },
   "extensionDependencies": [
     "ms-python.python"

pyproject.toml

@@ -4,14 +4,14 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "robotcode"
-version = "0.7.4-preview"
+version = "0.7.4dev"
 description = "Language server, debugger and tools for RobotFramework"
 authors = ["Daniel Biehl <[email protected]>"]
 homepage = 'https://github.com/d-biehl/robotcode'
 repository = 'https://github.com/d-biehl/robotcode'
 readme = "README.md"
 license = "Apache-2.0"
-include = ["robotcode/py.typed", "README.md"]
+include = ["robotcode/py.typed", "README.md", "CHANGELOG.md"]
 exclude = ["robotcode/external"]
 keywords = [
   "Test",
@@ -49,9 +49,7 @@ classifiers = [
 ]
 
 [tool.poetry.scripts]
-npm-package = 'scripts.npm_package:main'
-npm-publish = 'scripts.npm_publish:main'
-extract-release-notes='scripts.extract_release_notes:main'
+npm='scripts.npm:main'
 
 [tool.poetry.dependencies]
 python = "^3.8"

scripts/extract_release_notes.py

@@ -1,38 +1,11 @@
-import os
 import re
 from pathlib import Path
 
-from git.repo import Repo
-from semantic_version import Version
-
-
-def get_current_version_from_git() -> Version:
-    repo = Repo(Path.cwd())
-
-    result = None
-    for tag in repo.tags:
-        v = tag.name
-        if v.startswith("v."):
-            v = v[2:]
-        elif v.startswith("v"):
-            v = v[1:]
-
-        try:
-            v = Version(v)
-        except ValueError:
-            continue
-
-        if not result or v > result:
-            result = v
-
-    return result
+from scripts.tools import get_version
 
 
 def main() -> None:
-    if "npm_package_version" in os.environ:
-        version = Version(os.environ["npm_package_version"])
-    else:
-        version = get_current_version_from_git()
+    version = get_version()
 
     changelog = Path("CHANGELOG.md").read_text()
 

scripts/npm_package.py renamed to scripts/npm.py

@@ -1,8 +1,9 @@
+import sys
 from subprocess import run
 
 
 def main() -> None:
-    run("npm run package", shell=True).check_returncode()
+    run(f"npm run {' '.join(sys.argv[1:])}", shell=True).check_returncode()
 
 
 if __name__ == "__main__":

scripts/npm_publish.py

@@ -1,44 +1,17 @@
-import os
 from pathlib import Path
 from subprocess import run
 
-from git.repo import Repo
-from semantic_version import Version
-
-
-def get_current_version_from_git() -> Version:
-    repo = Repo(Path.cwd())
-
-    result = None
-    for tag in repo.tags:
-        v = tag.name
-        if v.startswith("v."):
-            v = v[2:]
-        elif v.startswith("v"):
-            v = v[1:]
-
-        try:
-            v = Version(v)
-        except ValueError:
-            continue
-
-        if not result or v > result:
-            result = v
-
-    return result
+from scripts.tools import get_version
 
 
 def main() -> None:
     dist_path = Path("./dist")
     if not dist_path.exists():
         dist_path.mkdir()
 
-    if "npm_package_version" in os.environ:
-        current_version = Version(os.environ["npm_package_version"])
-    else:
-        current_version = get_current_version_from_git()
+    version = get_version()
 
-    pre_release = current_version.minor % 2 != 0
+    pre_release = version.minor % 2 != 0
 
     run(f"npx vsce package {'--pre-release' if pre_release else ''} -o ./dist", shell=True).check_returncode()
 

scripts/package.py

@@ -2,30 +2,7 @@
 from pathlib import Path
 from subprocess import run
 
-from git.repo import Repo
-from semantic_version import Version
-
-
-def get_current_version_from_git() -> Version:
-    repo = Repo(Path.cwd())
-
-    result = None
-    for tag in repo.tags:
-        v = tag.name
-        if v.startswith("v."):
-            v = v[2:]
-        elif v.startswith("v"):
-            v = v[1:]
-
-        try:
-            v = Version(v)
-        except ValueError:
-            continue
-
-        if not result or v > result:
-            result = v
-
-    return result
+from scripts.tools import get_version
 
 
 def main() -> None:
@@ -34,10 +11,7 @@ def main() -> None:
     if not dist_path.exists():
         raise FileNotFoundError(f"dist folder '{dist_path}' not exists")
 
-    if "npm_package_version" in os.environ:
-        current_version = Version(os.environ["npm_package_version"])
-    else:
-        current_version = get_current_version_from_git()
+    current_version = get_version()
 
     vsix_path = Path(dist_path, f"robotcode-{current_version}.vsix")
 

scripts/publish.py

@@ -0,0 +1,34 @@
+import os
+from pathlib import Path
+
+from git.repo import Repo
+from semantic_version import Version
+
+
+def get_current_version_from_git() -> Version:
+    repo = Repo(Path.cwd())
+
+    result = None
+    for tag in repo.tags:
+        v = tag.name
+        if v.startswith("v."):
+            v = v[2:]
+        elif v.startswith("v"):
+            v = v[1:]
+
+        try:
+            v = Version(v)
+        except ValueError:
+            continue
+
+        if not result or v > result:
+            result = v
+
+    return result
+
+
+def get_version() -> Version:
+    if "npm_package_version" in os.environ:
+        return Version(os.environ["npm_package_version"])
+    else:
+        return get_current_version_from_git()