From e6429ee15f68f30d954c441b50486a657c23c756 Mon Sep 17 00:00:00 2001 From: Dan Fuchs Date: Thu, 14 Nov 2024 18:27:29 -0600 Subject: [PATCH 1/3] `#dm-docs-support` -> `#square-docs-support` --- changelog.d/20241118_133228_danfuchs_DM_47580.md | 3 +++ src/ltdconveyor/keeper/v1/build.py | 6 +++--- 2 files changed, 6 insertions(+), 3 deletions(-) create mode 100644 changelog.d/20241118_133228_danfuchs_DM_47580.md diff --git a/changelog.d/20241118_133228_danfuchs_DM_47580.md b/changelog.d/20241118_133228_danfuchs_DM_47580.md new file mode 100644 index 0000000..3daf57c --- /dev/null +++ b/changelog.d/20241118_133228_danfuchs_DM_47580.md @@ -0,0 +1,3 @@ +### Bug fixes + +- Change Slack channel references to refer to channels in the Rubin Slack instance. diff --git a/src/ltdconveyor/keeper/v1/build.py b/src/ltdconveyor/keeper/v1/build.py index eebe162..e41fb38 100644 --- a/src/ltdconveyor/keeper/v1/build.py +++ b/src/ltdconveyor/keeper/v1/build.py @@ -123,7 +123,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, ) @@ -132,7 +132,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, ) @@ -166,7 +166,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, ) From ecc54f8ce57493ad3af131bfa1018bec0059441e Mon Sep 17 00:00:00 2001 From: Dan Fuchs Date: Mon, 18 Nov 2024 13:55:56 -0600 Subject: [PATCH 2/3] `types-pkg_resources` -> `types-setuptools` [types-pkg_resources](https://pypi.org/project/types-pkg-resources/) has been yanked from pypi, replaced by [types-setuptools](https://pypi.org/project/types-setuptools/) --- changelog.d/20241118_133228_danfuchs_DM_47580.md | 1 + pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/changelog.d/20241118_133228_danfuchs_DM_47580.md b/changelog.d/20241118_133228_danfuchs_DM_47580.md index 3daf57c..370d62a 100644 --- a/changelog.d/20241118_133228_danfuchs_DM_47580.md +++ b/changelog.d/20241118_133228_danfuchs_DM_47580.md @@ -1,3 +1,4 @@ ### Bug fixes - Change Slack channel references to refer to channels in the Rubin Slack instance. +- Get non-sensitive CI vars from GitHub variables instead of secrets diff --git a/pyproject.toml b/pyproject.toml index 4bd01b2..7e7e27f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -46,7 +46,7 @@ dev = [ "coverage[toml]", "mypy", "types-requests", - "types-pkg_resources", + "types-setuptools", # Documentation "documenteer[guide]", "sphinx-click", From f6a644182d5b10e92ce52039450f32983f57409e Mon Sep 17 00:00:00 2001 From: Dan Fuchs Date: Tue, 19 Nov 2024 09:35:36 -0600 Subject: [PATCH 3/3] Document GitHub actions AWS integration --- .github/workflows/ci.yaml | 4 ++-- changelog.d/20241118_133228_danfuchs_DM_47580.md | 1 - docs/development.rst | 10 ++++++++++ 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 2efd61d..80e8145 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -57,9 +57,9 @@ jobs: python-version: ${{ matrix.python }} tox-envs: "py,typing" 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: diff --git a/changelog.d/20241118_133228_danfuchs_DM_47580.md b/changelog.d/20241118_133228_danfuchs_DM_47580.md index 370d62a..3daf57c 100644 --- a/changelog.d/20241118_133228_danfuchs_DM_47580.md +++ b/changelog.d/20241118_133228_danfuchs_DM_47580.md @@ -1,4 +1,3 @@ ### Bug fixes - Change Slack channel references to refer to channels in the Rubin Slack instance. -- Get non-sensitive CI vars from GitHub variables instead of secrets diff --git a/docs/development.rst b/docs/development.rst index 6e3b65e..2138672 100644 --- a/docs/development.rst +++ b/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 `_ 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 `_ and `variables `_ + +These creds are attached to the `ltd-conveyor-tests IAM user `_. +This user has an attached `ltd-conveyor-tests policy `_. +This policy grants access to the `lsst-the-docs-test S3 bucket `_.