merge skeleton features

Author: gilesknap

.github/workflows/code.yml

@@ -2,21 +2,16 @@ name: Code CI
 
 on:
   push:
-    branches:
-      # Restricting to these branches and tags stops duplicate jobs on internal
-      # PRs but stops CI running on internal branches without a PR. Delete the
-      # next 5 lines to restore the original behaviour
-      - master
-      - main
-    tags:
-      - "*"
   pull_request:
   schedule:
     # Run every Monday at 8am to check latest versions of dependencies
     - cron: "0 8 * * MON"
 
 jobs:
   lint:
+    # pull requests are a duplicate of a branch push if they are from within the
+    # same repo. Skip these
+    if: github.event_name != 'pull_request' || github.event.pull_request.repository == github.repository
     runs-on: "ubuntu-latest"
     steps:
       - name: Checkout
@@ -28,6 +23,7 @@ jobs:
           tox -e pre-commit,mypy
 
   wheel:
+    if: github.event_name != 'pull_request' || github.event.pull_request.repository == github.repository
     strategy:
       fail-fast: false
       matrix:
@@ -59,6 +55,7 @@ jobs:
         run: pipx run --python $(which python${{ matrix.python }}) --spec dist/*.whl python3-pip-skeleton --version
 
   test:
+    if: github.event_name != 'pull_request' || github.event.pull_request.repository == github.repository
     strategy:
       fail-fast: false
       matrix:
@@ -98,17 +95,16 @@ jobs:
       - name: Install with locked dependencies
         if: matrix.lock
         run: |
-          echo '# runtime dependencies' > requirements.txt 
-          echo '# developer dependencies' > requirements_dev.txt
-          # above avoids zero length requirements files
+          touch requirements.txt 
+          touch requirements_dev.txt
           pip install -r requirements.txt -e .
           pip freeze --exclude-editable >> requirements.txt
           pip install -r requirements_dev.txt -e .[dev]
           pip freeze --exclude-editable >> requirements_dev.txt
 
       - name: Install with latest dependencies
         if: ${{ ! matrix.lock }}
-        run: pip install -e .[dev]
+        run: pip install .[dev]
 
       - name: Run tests
         run: pytest tests

.github/workflows/docs.yml

@@ -2,10 +2,6 @@ name: Docs CI
 
 on:
   push:
-    branches:
-      # Add more branches here to publish docs from other branches
-      - master
-      - main
     tags:
       - "*"
   pull_request:

docs/explanations/features.rst

@@ -0,0 +1,34 @@
+Feature Update History
+======================
+
+August 18th 2022
+----------------
+
+.. _CLI: https://epics-containers.github.io/python3-pip-skeleton-cli/
+.. _skeleton: https://epics-containers.github.io/python3-pip-skeleton/
+
+- Project split into 2 repos
+  
+  - this project CLI_ provides this documentation and the code for adopting
+    skeleton
+  - the skeleton_ project provides the template source for adoption 
+  - this avoids the confusion of using two 'main' branches in a single repo
+  - it also allows for separate github settings for the CLI and skeleton as
+    follows:
+
+    - TODO list github branch and PR settings 
+
+- Now allow CI to run on all branches but avoid duplicate CI runs using
+  https://github.com/marketplace/actions/skip-duplicate-actions
+- Now use non-editable pip install for tests that do not use requirements.txt
+
+  - This verifies that the packaging is working  
+
+- the --org option when adopting is now mandatory to avoid accidentally 
+  creating a repo for the default org.
+- moved 'contributing.rst' from reference to how-to meaning that we no
+  longer require a dummy how-to article
+- removed example code hello.py meaning that this does not 
+  have to be deleted after adopting. Also removed related tests.
+- Skeleton README reduced to remove example code and to point at 
+  skeleton-cli for instructions.

docs/how-to.rst

@@ -11,3 +11,4 @@ Practical step-by-step guides for the more experienced user.
     how-to/existing
     how-to/update
     how-to/excalidraw
+    how-to/contributing

docs/reference/contributing.rst docs/how-to/contributing.rstdocs/reference/contributing.rst renamed to docs/how-to/contributing.rst

@@ -8,7 +8,6 @@ Practical step-by-step guides for the more experienced user.
 .. toctree::
     :caption: Reference
 
-    reference/contributing
     Releases <https://github.com/epics-containers/python3-pip-skeleton/releases>
     Index <genindex.html#http://>
 

docs/reference.rst

@@ -4,7 +4,7 @@ Installation
 .. note::
 
     If you want to contribute to the library itself, please follow
-    the `../reference/contributing` instructions.
+    the `../how-to/contributing` instructions.
 
 
 Check your version of python

docs/tutorials/installation.rst

@@ -229,9 +229,7 @@ def main(args=None):
     sub = subparsers.add_parser("new", help="Make a new repo forked from this skeleton")
     sub.set_defaults(func=new)
     sub.add_argument("path", type=Path, help="Path to new repo to create")
-    sub.add_argument(
-        "--org", default="epics-containers", help="GitHub org, default epics-containers"
-    )
+    sub.add_argument("--org", required=True, help="GitHub organization for the repo")
     sub.add_argument(
         "--package", default=None, help="Package name, defaults to directory name"
     )
@@ -245,9 +243,7 @@ def main(args=None):
     sub = subparsers.add_parser("existing", help="Adopt skeleton in existing repo")
     sub.set_defaults(func=existing)
     sub.add_argument("path", type=Path, help="Path to new repo to existing repo")
-    sub.add_argument(
-        "--org", default="epics-containers", help="GitHub org, default epics-containers"
-    )
+    sub.add_argument("--org", required=True, help="GitHub organization for the repo")
     sub.add_argument(
         "--package", default=None, help="Package name, defaults to directory name"
     )

src/python3_pip_skeleton/__main__.py

@@ -114,6 +114,7 @@ def test_existing_module(tmp_path: Path):
         "-m",
         "python3_pip_skeleton",
         "existing",
+        "--org=epics-containers",
         str(module),
     )
     assert output.endswith(
@@ -134,6 +135,7 @@ def test_existing_module(tmp_path: Path):
             "-m",
             "python3_pip_skeleton",
             "existing",
+            "--org=epics-containers",
             str(module),
         )
     assert (
@@ -172,6 +174,7 @@ def test_existing_module_already_adopted(tmp_path: Path):
             "-m",
             "python3_pip_skeleton",
             "existing",
+            "--org=epics-containers",
             str(module),
         )
     assert "already adopted skeleton" in str(excinfo.value)