Skip to content

Commit

Permalink
Add the list of required secrets to CI readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pi-alexander-popel committed Jun 13, 2023
1 parent 6921d5a commit e4a9ee0
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
1 change: 0 additions & 1 deletion .github/workflows/nightly-prs-to-main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,3 @@ jobs:
secrets:
token: ${{ secrets.ACCESS_TOKEN }}
asset-keys: '{"TestResourceKey": "${{ secrets.SUPER_RESOURCE_KEY}}"}'

1 change: 0 additions & 1 deletion .github/workflows/nightly-publish-main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ jobs:
secrets:
token: ${{ secrets.ACCESS_TOKEN }}
asset-keys: '{"TestResourceKey": "${{ secrets.SUPER_RESOURCE_KEY}}", "PypiToken": "${{ secrets.PYPI_TOKEN }}"}'

10 changes: 9 additions & 1 deletion ci/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,10 @@
# API Specific CI/CD Approach
This API complies with the `common-ci` approach.
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`

0 comments on commit e4a9ee0

Please sign in to comment.