@@ -94,7 +94,7 @@ along with a request for feedback.
94
94
95
95
Pull requests will generally not be accepted if any tests are failing.
96
96
Therefore, it is recommended that you run the tests before submitting your pull
97
- request. After making a pull request, check the Travis build status in the
97
+ request. After making a pull request, check the build status in the
98
98
GitHub interface to ensure that all tests are running as expected. If any checks
99
99
fail, you may push additional commits to your branch. GitHub will add those
100
100
commits to the pull request and rerun the checks.
@@ -407,20 +407,25 @@ following steps:
407
407
408
408
Bump version to X.X.X
409
409
410
- 6 . After all checks (Travis, etc.) have passed, merge the pull request.
410
+ 6 . After all checks have passed, merge the pull request.
411
411
412
412
7 . Create a git tag with the new version as the tag name and push to the
413
- [ Python-Markdown/markdown] repository.
413
+ [ Python-Markdown/markdown] repository. The new tag should trigger a GitHub
414
+ workflow which will automatically deploy the release to PyPI and update the
415
+ documentation.
414
416
415
- 8 . Deploy the release to [ PyPI] with the command ` make deploy ` .
417
+ In the event that the deployment fails, the following steps can be taken to
418
+ deploy manually:
416
419
417
- 9 . Deploy an update to the documentation using [ MkDocs] . The following example
418
- assumes that local clones of the [ Python-Markdown/markdown] and
419
- [ Python-Markdown/Python-Markdown.github.io] repositories are in sibling
420
- directories named ` markdown ` and ` Python-Markdown.github.io ` respectively.
420
+ - Deploy the release to [ PyPI] with the command ` make deploy ` .
421
421
422
- cd Python-Markdown.github.io
423
- mkdocs gh-deploy --config-file ../markdown/mkdocs.yml --remote-branch master
422
+ - Deploy an update to the documentation using [ MkDocs] . The following example
423
+ assumes that local clones of the [ Python-Markdown/markdown] and
424
+ [ Python-Markdown/Python-Markdown.github.io] repositories are in sibling
425
+ directories named ` markdown ` and ` Python-Markdown.github.io ` respectively.
426
+
427
+ cd Python-Markdown.github.io
428
+ mkdocs gh-deploy --config-file ../markdown/mkdocs.yml --remote-branch master
424
429
425
430
## Issue and Pull Request Labels
426
431
0 commit comments