Merge pull request #70 from lsst-sqre/tickets/DM-47580/cherrypick

DM-47580: Backport slack channel and build changes

Author: fajpunk

.github/workflows/ci.yaml

@@ -31,9 +31,9 @@ jobs:
           python-version: ${{ matrix.python }}
           tox-envs: "lint,typing,py"
         env:
-          LTD_TEST_AWS_ID: ${{ secrets.LTD_TEST_AWS_ID }}
+          LTD_TEST_AWS_ID: ${{ vars.LTD_TEST_AWS_ID }}
           LTD_TEST_AWS_SECRET: ${{ secrets.LTD_TEST_AWS_SECRET }}
-          LTD_TEST_BUCKET: ${{ secrets.LTD_TEST_BUCKET }}
+          LTD_TEST_BUCKET: ${{ vars.LTD_TEST_BUCKET }}
 
   docs:
 

CHANGELOG.rst

@@ -2,6 +2,14 @@
 Change log
 ##########
 
+0.8.4 (2024-11-19)
+==================
+
+Changed
+-------
+
+- Change Slack channel references to refer to channels in the Rubin Slack instance.
+
 0.8.3 (2024-02-22)
 ==================
 

docs/development.rst

@@ -29,3 +29,13 @@ Releases are made by creating a Git tag with a semantic version and pushing to G
    git push --tags
 
 Travis CI creates the PyPI release itself and `setuptools_scm <https://github.com/pypa/setuptools_scm/>`_ ensures the PyPI version matches the Git tag.
+
+GitHub CI
+=========
+
+The GitHub CI action needs AWS creds and an existing S3 bucket.
+These creds and the bucket name are injected via repository-scoped Actions `secrets <https://github.com/lsst-sqre/ltd-conveyor/settings/secrets/actions>`_ and `variables <https://github.com/lsst-sqre/ltd-conveyor/settings/variables/actions>`_
+
+These creds are attached to the `ltd-conveyor-tests IAM user <https://us-east-1.console.aws.amazon.com/iam/home?region=us-west-2#/users/details/ltd-conveyor-tests?section=permissions>`_.
+This user has an attached `ltd-conveyor-tests policy <https://us-east-1.console.aws.amazon.com/iam/home?region=us-west-2#/policies/details/arn%3Aaws%3Aiam%3A%3A039289279626%3Apolicy%2Fltd-conveyor-tests?section=permissions>`_.
+This policy grants access to the `lsst-the-docs-test S3 bucket <https://us-west-2.console.aws.amazon.com/s3/buckets/lsst-the-docs-test?region=us-west-2&bucketType=general&tab=objects>`_.

setup.cfg

@@ -59,7 +59,7 @@ dev =
     Sphinx
     mypy
     types-requests
-    types-pkg_resources
+    types-setuptools
 
 [options.entry_points]
 console_scripts =

src/ltdconveyor/keeper/build.py

@@ -75,7 +75,7 @@ def register_build(
             raise KeeperError(
                 f"Could not register a new build for the project {product}. "
                 "It's possible that the project is not registered yet. Please "
-                "contact #dm-docs-support on Slack.",
+                "contact #square-docs-support on Slack.",
                 r2.status_code,
                 r2.text,
             )
@@ -84,7 +84,7 @@ def register_build(
             f"Could not register a new build for the project {product}. "
             "It's possible that another build is currently underway. Please "
             "re-run the documentation job in a few minutes. If the problem "
-            "persists, contact #dm-docs-support on Slack.",
+            "persists, contact #square-docs-support on Slack.",
             r.status_code,
             r.text,
         )
@@ -117,7 +117,7 @@ def confirm_build(build_url: str, keeper_token: str) -> None:
     if r.status_code != 200:
         raise KeeperError(
             f"Could not confirm build upload for {build_url}. "
-            "Contact #dm-docs-support on Slack",
+            "Contact #square-docs-support on Slack",
             r.status_code,
             r.text,
         )