Skip to content

Commit 3bb9d42

Browse files
committed
Update documentation for release process
1 parent 3870f20 commit 3bb9d42

File tree

1 file changed

+42
-20
lines changed

1 file changed

+42
-20
lines changed

docs/contributing.md

Lines changed: 42 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -474,24 +474,37 @@ following steps:
474474

475475
3. Update the version defined in [`markdown/__meta__.py`][markdown/__meta__.py].
476476

477-
4. Build a local copy of the documentation, browse through the pages and
477+
4. Build a local copy of the documentation and browse through the pages to
478478
confirm that no obvious issues exist with the documentation.
479479

480-
5. Create a pull request with a commit message in the following format:
480+
5. Create a pull request labeled `release`{ .label .release } with a commit
481+
message in the following format:
481482

482483
Bump version to X.X.X
483484

485+
!!! note
486+
487+
For the checks to run properly the `release`{ .label .release } label
488+
must be set on GitHub before creating the pull request. If the label
489+
is added to the pull request later, additional changes will need to
490+
be pushed to the pull request for the checks to acknowledge the
491+
label.The relevant check verifies that the version defined in the
492+
code matches the latest version in the changelog and that the
493+
changelog no longer lists an `unreleased` entry. This check is
494+
nessecary to ensure deployment will not fail later.
495+
484496
6. After all checks have passed, merge the pull request.
485497

486-
7. Create a git tag with the new version as the tag name and push to the
487-
[Python-Markdown/markdown] repository. The new tag should trigger a GitHub
488-
workflow which will automatically deploy the release to PyPI and update the
489-
documentation.
498+
7. Create a git tag with the new version as the tag name (in the format X.X.X
499+
with no prefixes or sufixes) and push to the [Python-Markdown/markdown]
500+
repository. The new tag should trigger a GitHub workflow which will
501+
automatically deploy the release to PyPI and update the documentation.
490502

491503
In the event that the deployment fails, the following steps can be taken to
492504
deploy manually:
493505

494-
- Deploy the release to [PyPI] with the command `make deploy`.
506+
- Deploy the release to [PyPI] with the command `make deploy` (a valid
507+
authentication token will need to be provided).
495508

496509
- Deploy an update to the documentation using [MkDocs]. The following example
497510
assumes that local clones of the [Python-Markdown/markdown] and
@@ -504,7 +517,7 @@ following steps:
504517

505518
## Issue and Pull Request Labels
506519

507-
Below are the labels used to track and manages issues and pull requests. The
520+
Below are the labels used to track and manage issues and pull requests. The
508521
labels are loosely grouped by their purpose, but it is not necessary for every
509522
issue to have a label from every group, and an issue may have more than one
510523
label from the same group.
@@ -551,6 +564,10 @@ label from the same group.
551564
| `approved`{ .label .approved } | The pull request is ready to be merged. |
552565
| `rejected`{ .label .rejected } | The pull request is rejected for the stated reasons. |
553566

567+
One additional label exists named `release`{ .label .release }. This label should only be
568+
assigned to pull requests which bump the version. See the [Release Process](#release-process)
569+
for details.
570+
554571
[Python-Markdown Organization]: https://github.com/Python-Markdown
555572
[Python-Markdown Code of Conduct]: https://github.com/Python-Markdown/markdown/blob/master/CODE_OF_CONDUCT.md
556573
[Python-Markdown/markdown]: https://github.com/Python-Markdown/markdown
@@ -596,41 +613,46 @@ label from the same group.
596613
font-weight: 600;
597614
line-height: 15px;
598615
display: inline-block;
599-
padding: 4px 6px;
616+
padding: 0 8px;
617+
margin: 4px 0;
618+
border-radius: 999px;
600619
}
601620
code.bug {
602-
background-color: #c45b46;
621+
background-color: #c45b46 !important;
603622
}
604623
code.feature {
605-
background-color: #7b17d8;
624+
background-color: #7b17d8 !important;
606625
color: #ffffff;
607626
}
608627
code.support {
609-
background-color: #efbe62;
628+
background-color: #efbe62 !important;
610629
}
611630
code.process {
612-
background-color: #eec9ff;
631+
background-color: #eec9ff !important;
613632
}
614633
code.core {
615-
background-color: #0b02e1;
634+
background-color: #0b02e1 !important;
616635
color: #ffffff;
617636
}
618637
code.extension {
619-
background-color: #709ad8;
638+
background-color: #709ad8 !important;
620639
}
621640
code.docs {
622-
background-color: #b2ffeb;
641+
background-color: #b2ffeb !important;
623642
}
624643
code.approved {
625-
background-color: #beed6d;
644+
background-color: #beed6d !important;
626645
}
627646
code.low {
628-
background-color: #dddddd;
647+
background-color: #dddddd !important;
629648
}
630649
code.pending {
631-
background-color: #f0f49a;
650+
background-color: #f0f49a !important;
632651
}
633652
code.rejected {
634-
background-color: #f7c7be;
653+
background-color: #f7c7be !important;
654+
}
655+
code.release {
656+
background-color: #d4c5f9 !important;
635657
}
636658
</style>

0 commit comments

Comments
 (0)