You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: skeleton.md
+16-11Lines changed: 16 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,6 +56,7 @@ The features/techniques employed by the skeleton include:
56
56
- A README.rst as reStructuredText with some popular badges, but with Read the Docs and AppVeyor badges commented out
57
57
- A CHANGES.rst file intended for publishing release notes about the project
58
58
- Use of [Black](https://black.readthedocs.io/en/stable/) for code formatting (disabled on unsupported Python 3.5 and earlier)
59
+
- Integrated type checking through [mypy](https://github.com/python/mypy/).
59
60
60
61
## Packaging Conventions
61
62
@@ -109,9 +110,20 @@ Relies on a .flake8 file to correct some default behaviors:
109
110
110
111
The project is pre-configured to run tests through multiple CI providers.
111
112
113
+
### Github Actions
114
+
115
+
[Github Actions](https://docs.github.com/en/free-pro-team@latest/actions) are the preferred provider as they provide free, fast, multi-platform services with straightforward configuration. Configured in `.github/workflows`.
116
+
117
+
Features include:
118
+
- test against multiple Python versions
119
+
- run on late (and updated) platform versions
120
+
- automated releases of tagged commits
121
+
112
122
### Azure Pipelines
113
123
114
-
[Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) are the preferred provider as they provide free, fast, multi-platform services. See azure-pipelines.yml for more details.
124
+
[Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) were adopted for free, fast, multi-platform services. See azure-pipelines.yml for more details.
125
+
126
+
Azure Pipelines require many [complicated setup steps](https://github.com/Azure/azure-devops-cli-extension/issues/968) that have not been readily automated.
115
127
116
128
Features include:
117
129
@@ -133,20 +145,13 @@ A minimal template for running under AppVeyor (Windows) is provided.
133
145
134
146
### Continuous Deployments
135
147
136
-
In addition to running tests, an additional deploy stage is configured to automatically release tagged commits to PyPI using [API tokens](https://pypi.org/help/#apitoken). The release process expects an authorized token to be configured with Azure as the `Azure secrets` variable group. This variable group needs to be created only once per organization. For example:
148
+
In addition to running tests, an additional publish stage is configured to automatically release tagged commits to PyPI using [API tokens](https://pypi.org/help/#apitoken). The release process expects an authorized token to be configured with each Github project (or org) `PYPI_TOKEN`[secret](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets). Example:
137
149
138
150
```
139
-
# create a resource group if none exists
140
-
az group create --name main --location eastus2
141
-
# create the vault (try different names until something works)
142
-
az keyvault create --name secrets007 --resource-group main
143
-
# create the secret
144
-
az keyvault secret set --vault-name secrets007 --name PyPI-token --value $token
0 commit comments