@@ -27,11 +27,17 @@ previous python versions directly in the CI pipeline to catch these bugs.
27
27
* Owner: The github repository owner (in this case ` febus982 ` )
28
28
* Repository name: The github repository name (in this case ` bootstrap-python-package ` )
29
29
* Workflow name: ` release.yml `
30
- * Enable GitHub Actions for GitHub Pages (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages )
31
30
* Create a GitHub Actions secret named ` CODECLIMATE_REPORTER_ID ` (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions )
32
31
containing the codeclimate reporter id (you can find it at https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter ).
33
32
If you don't want to use CodeClimate just delete ` workflows/python-quality.yml ` .
34
33
* Update the badges in ` README.md ` ! (check [ shields.io] ( https://shields.io/ ) for extra badges)
34
+ * Setup local development:
35
+ * Clone the repository
36
+ * Install poetry ` pip install poetry `
37
+ * Install dev dependencies with ` make dev-dependencies `
38
+ * Setup GitHub pages (this need local development setup):
39
+ * Initialise documentation branch ` poetry run mike deploy dev latest --update-aliases --push `
40
+ * Enable GitHub Actions for GitHub Pages (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages )
35
41
36
42
** IMPORTANT:** The repository is configured to deploy on the [ test PyPI repository] ( https://test.pypi.org/ ) .
37
43
It's strongly recommended to create the project in the [ test PyPI repository] ( https://test.pypi.org/ ) and test
@@ -58,6 +64,7 @@ This format can be customized, refer to [poetry-dynamic-versioning docs](https:/
58
64
All the common commands used during development can be run using make targets:
59
65
60
66
* ` make dev-dependencies ` : Install dev requirements
67
+ * ` make update-dependencies ` : Update dev requirements
61
68
* ` make test ` : Run test suite
62
69
* ` make check ` : Run tests, code style and lint checks
63
70
* ` make fix ` : Run code style and lint automatic fixes (where possible)
0 commit comments