From e4a9ee05009de6cd64179864797d911dbab6edc4 Mon Sep 17 00:00:00 2001 From: Alexander Popel Date: Mon, 12 Jun 2023 17:30:46 +0300 Subject: [PATCH] Add the list of required secrets to CI readme --- .github/workflows/nightly-prs-to-main.yml | 1 - .github/workflows/nightly-publish-main.yml | 1 - ci/README.md | 10 +++++++++- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/.github/workflows/nightly-prs-to-main.yml b/.github/workflows/nightly-prs-to-main.yml index b43d52a..59152b1 100644 --- a/.github/workflows/nightly-prs-to-main.yml +++ b/.github/workflows/nightly-prs-to-main.yml @@ -19,4 +19,3 @@ jobs: secrets: token: ${{ secrets.ACCESS_TOKEN }} asset-keys: '{"TestResourceKey": "${{ secrets.SUPER_RESOURCE_KEY}}"}' - diff --git a/.github/workflows/nightly-publish-main.yml b/.github/workflows/nightly-publish-main.yml index 3726adf..5b919aa 100644 --- a/.github/workflows/nightly-publish-main.yml +++ b/.github/workflows/nightly-publish-main.yml @@ -20,4 +20,3 @@ jobs: secrets: token: ${{ secrets.ACCESS_TOKEN }} asset-keys: '{"TestResourceKey": "${{ secrets.SUPER_RESOURCE_KEY}}", "PypiToken": "${{ secrets.PYPI_TOKEN }}"}' - diff --git a/ci/README.md b/ci/README.md index d58d90d..f5d4b75 100644 --- a/ci/README.md +++ b/ci/README.md @@ -1,2 +1,10 @@ # API Specific CI/CD Approach -This API complies with the `common-ci` approach. \ No newline at end of file +This API complies with the `common-ci` approach. + +The following secrets are required: +* `ACCESS_TOKEN` - GitHub [access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#about-personal-access-tokens) for cloning repos, creating PRs, etc. + * Example: `github_pat_l0ng_r4nd0m_s7r1ng` +* `SUPER_RESOURCE_KEY` - [resource key](https://51degrees.com/documentation/4.4/_info__resource_keys.html) for integration tests + * Example: `R4nd0m-S7r1ng` +* `PYPI_TOKEN` - [PyPI token](https://pypi.org/help/#apitoken) for publishing packages + * Example: `pypi-sUp3r-l0nG_r4nd0m-s7r1Ng`