Skip to content

Commit dcd7cbd

Browse files
committed
Refresh docs to prefer Github Actions to Azure Pipelines. Ref jaraco/skeleton#24.
1 parent ce34be2 commit dcd7cbd

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

skeleton.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ The features/techniques employed by the skeleton include:
5656
- A README.rst as reStructuredText with some popular badges, but with Read the Docs and AppVeyor badges commented out
5757
- A CHANGES.rst file intended for publishing release notes about the project
5858
- 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/).
5960

6061
## Packaging Conventions
6162

@@ -109,9 +110,20 @@ Relies on a .flake8 file to correct some default behaviors:
109110

110111
The project is pre-configured to run tests through multiple CI providers.
111112

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+
112122
### Azure Pipelines
113123

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.
115127

116128
Features include:
117129

@@ -133,20 +145,13 @@ A minimal template for running under AppVeyor (Windows) is provided.
133145

134146
### Continuous Deployments
135147

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:
137149

138150
```
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
151+
pip-run -q setuptools jaraco.develop -- -m jaraco.develop.add-github-secret PYPI_TOKEN $TOKEN --project org/repo
145152
```
146153

147-
Then, in the web UI for the project's Pipelines Library, create the `Azure secrets` variable group referencing the key vault name.
148-
149-
For more details, see [this blog entry](https://blog.jaraco.com/configuring-azure-pipelines-with-secets/).
154+
<!-- note setuptools is required due to a [bug in munch](https://github.com/Infinidat/munch/issues/67) -->
150155

151156
## Building Documentation
152157

0 commit comments

Comments
 (0)