Skip to content

Commit adc2f63

Browse files
committed
Add configuration step for github pages in documentation
1 parent 119df57 commit adc2f63

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ previous python versions directly in the CI pipeline to catch these bugs.
4141
* Owner: The github repository owner (in this case `febus982`)
4242
* Repository name: The github repository name (in this case `bootstrap-python-package`)
4343
* Workflow name: `release.yml`
44-
* Create a github actions secret named `CODECLIMATE_REPORTER_ID` (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions)
44+
* Enable GitHub Actions for GitHub Pages (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages)
45+
* Create a GitHub Actions secret named `CODECLIMATE_REPORTER_ID` (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions)
4546
containing the codeclimate reporter id (you can find it at https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter).
4647
If you don't want to use CodeClimate just delete `workflows/python-quality.yml`.
4748
* Update the badges in `README.md`! (check [shields.io](https://shields.io/) for extra badges)

docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ previous python versions directly in the CI pipeline to catch these bugs.
2727
* Owner: The github repository owner (in this case `febus982`)
2828
* Repository name: The github repository name (in this case `bootstrap-python-package`)
2929
* Workflow name: `release.yml`
30-
* Create a github actions secret named `CODECLIMATE_REPORTER_ID` (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions)
30+
* Enable GitHub Actions for GitHub Pages (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages)
31+
* Create a GitHub Actions secret named `CODECLIMATE_REPORTER_ID` (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions)
3132
containing the codeclimate reporter id (you can find it at https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter).
3233
If you don't want to use CodeClimate just delete `workflows/python-quality.yml`.
3334
* Update the badges in `README.md`! (check [shields.io](https://shields.io/) for extra badges)

0 commit comments

Comments
 (0)