feat: Updates docs and workflows (#9)

* feat: Updates docs and workflows

* fix: Changes after review

Author: lfvbarcus

.github/workflows/build.yml

@@ -1,6 +1,13 @@
 name: Build PyPI
 on:
-  workflow_call:
+  workflow_call: 
+  workflow_dispatch:
+  push:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
 
 jobs:
   linting:
@@ -20,8 +27,9 @@ jobs:
         with:
           python-version: "3.10"
       - name: Install dependencies
-        run: |
-          pip install hatch
+        run: pip install hatch
+      - name: Run unit and integrations tests
+        run: hatch run test:pytest --cov=reqstool-python-decorators --cov-report=xml --cov-report=html 
       - name: Build project
         run: hatch build
       # Upload artifacts for later use

.github/workflows/check_release.yml

@@ -0,0 +1,11 @@
+name: Lint (black and flake8)
+on:
+  workflow_call:
+
+jobs:
+  check-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check branch and tag
+        if: github.event_name == 'push' && !(github.ref == 'refs/heads/main' && startsWith(github.ref, 'refs/tags/v'))
+        run: exit 1

.github/workflows/lint.yml

@@ -1,5 +1,6 @@
-name: Linting (black and flake8)
+name: Lint (black and flake8)
 on:
+  workflow_dispatch:
   workflow_call:
 
 jobs:
@@ -17,6 +18,4 @@ jobs:
       - name: Run black formatter check
         run: hatch run lint:black --check --verbose src tests
       - name: Run flake8 linter
-        run: hatch run lint:flake8
-      - name: Run unit and integrations tests
-        run: hatch run test:pytest --cov=reqstool-python-decorators --cov-report=xml --cov-report=html
+        run: hatch run lint:flake8

.github/workflows/publish_pages.yml .github/workflows/publish_gh_pages.yml.github/workflows/publish_pages.yml renamed to .github/workflows/publish_gh_pages.yml

@@ -1,14 +1,12 @@
 name: Publish to GitHub Pages
 on:
+  workflow_dispatch:  
+  release:
+    types: [created]
   push:
     branches:
       - main
-  pull_request:
-    branches:
-      - main
 
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
 concurrency:
   group: github-pages
   cancel-in-progress: false
@@ -18,7 +16,7 @@ permissions:
   pages: write
   id-token: write
 jobs:
-  build:
+  publish-gh-pages:
     runs-on: ubuntu-latest
     environment:
       name: github-pages

.github/workflows/publish_production.yml .github/workflows/publish_pypi_prod.yml.github/workflows/publish_production.yml renamed to .github/workflows/publish_pypi_prod.yml

@@ -1,22 +1,25 @@
 name: Build and publish to PyPI
 
 on:
-  push:
-    branches:
-      - main
-    tags:
-      - "v*.*.*"
+  release:
+    types: [created]
 
 jobs:
+  check-release:
+    name: Reuse check release
+    uses: ./.github/workflows/check_release.yml
   build:
     name: Reuse build
     uses: ./.github/workflows/build.yml
+  
 
   publish-to-pypi:
-    needs: build
+    needs: 
+      - check-release
+      - build
     runs-on: ubuntu-latest
     environment:
-      name: production
+      name: prod
       url: https://pypi.org/p/reqstool-python-decorators
     permissions:
       id-token: write # IMPORTANT: this permission is mandatory for trusted publishing

.github/workflows/publish_development.yml .github/workflows/publish_pypi_test.yml.github/workflows/publish_development.yml renamed to .github/workflows/publish_pypi_test.yml

@@ -1,14 +1,7 @@
 name: Build and publish to Test PyPI
 
 on:
-  push:
-    branches-ignore:
-      - main
-  pull_request:
-    types:
-      - opened
-      - reopened
-      - synchronize
+  workflow_dispatch:
 
 jobs:
   build:
@@ -20,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     # Specifying a GitHub environment is optional, but strongly encouraged
     environment:
-      name: development
+      name: test
       url: https://test.pypi.org/p/reqstool-python-decorators
     permissions:
       id-token: write # IMPORTANT: this permission is mandatory for trusted publishing

docs/antora-playbook.yml

@@ -1,7 +1,7 @@
 # yaml-language-server: $schema=https://raw.githubusercontent.com/asciidoctor/asciidoctor-intellij-plugin/main/src/main/resources/jsonSchemas/antoraPlaybookSchema.json
 
 site:
-  title: Requirements Tool Documentation
+  title: Reqstool Python Decorators Documentation
   url: https://github.com/Luftfartsverket/reqstool-python-decorators.git
   start_page: reqstool-python-decorators::index.adoc
 

docs/modules/ROOT/pages/installation.adoc

@@ -1,9 +1,9 @@
 == Installation
 
-The package name is `reqstool-decorators`.
+The package name is `reqstool-python-decorators`.
 
 * Using pip install:
 
 ```
-$pip install reqstool-decorators 
+$pip install reqstool-python-decorators 
 ```

docs/modules/ROOT/pages/usage.adoc

@@ -6,23 +6,23 @@
 
 ```
 dependencies = [
-    "reqstool-decorators == <version>"
+    "reqstool-python-decorators == <version>"
 ]
 ```
 
 * Poetry
 
 ```
 [tool.poetry.dependencies]
-reqstool-decorators = "<version>"
+reqstool-python-decorators = "<version>"
 ```
 
 === Decorators
 
 Import decorators:
 
 ```
-from reqstool-decorators.decorators.decorators import Requirements, SVCs
+from reqstool_python_decorators.decorators.decorators import Requirements, SVCs
 ```
 
 Example usage of the decorators:
@@ -42,7 +42,7 @@ def test_somefunction():
 Import processor:
 
 ```
-from reqstool.processors.decorator_processor import ProcessDecorator
+from reqstool_python_decorators.processors.decorator_processor import ProcessDecorator
 ```
 
 Main function to collect decorators data and generate yaml file: