Skip to content

Commit c4bc628

Browse files
committed
Update CHANGELOG & HACKING.md
1 parent 7bdfa4e commit c4bc628

File tree

2 files changed

+27
-16
lines changed

2 files changed

+27
-16
lines changed

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Added
11+
12+
- Support for figure border flag ([DOP-1579](https://jira.mongodb.com/browse/DOP-1579))
13+
- Experimental support for installation on Windows
14+
15+
### Fixed
16+
17+
- Handling of :copyable: flag for code blocks ([DOP-1750](https://jira.mongodb.com/browse/DOP-1750))
18+
- Handling of duplicate header / label naming ([DOP-1326](https://jira.mongodb.com/browse/DOP-1326))
19+
- Installation behavior with new pip resolver
20+
1021
## [v0.8.1] - 2020-11-18
1122

1223
### Added

HACKING.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -108,29 +108,29 @@ This will generate an HTML representation of code coverage throughout the repo t
108108

109109
To release snooty, do the following:
110110

111-
* Make sure you are on the `master` branch.
111+
1. Make sure you are on the `master` branch.
112112

113-
* Ensure that the "Unreleased" section of CHANGELOG.md is up-to-date.
113+
2. Ensure that the "Unreleased" section of CHANGELOG.md is up-to-date.
114114

115-
* Run `make cut-release BUMP_TO_VERSION="<new_version>"`.
115+
3. Run `make cut-release BUMP_TO_VERSION="<new_version>"`.
116116

117-
The new version number should follow [semantic versioning](https://semver.org):
118-
`MAJOR.MINOR.PATCH`. For example, `make cut-release BUMP_TO_VERSION="0.1.2"`.
119-
Refer to `snooty/__init__.py` for the current version number.
117+
The new version number should follow [semantic versioning](https://semver.org):
118+
`MAJOR.MINOR.PATCH`. For example, `make cut-release BUMP_TO_VERSION="0.1.2"`.
119+
Refer to `snooty/__init__.py` for the current version number.
120120

121-
This will create a new tag named `v<new_version>` and push it to your origin,
122-
causing Github Actions to trigger the release process. After several minutes
123-
(you can monitor its progress at <https://github.com/mongodb/snooty-parser/actions>),
124-
a new release should be created with binaries for supported platforms.
121+
This will create a new tag named `v<new_version>` and push it to your origin,
122+
causing Github Actions to trigger the release process. After several minutes
123+
(you can monitor its progress at <https://github.com/mongodb/snooty-parser/actions>),
124+
a new release should be created with binaries for supported platforms.
125125

126-
You can instruct the `cut-release` target to avoid pushing the tag by passing the
127-
`PUSH_TO=""` option. For example, `make cut-release BUMP_TO_VERSION="0.1.2" PUSH_TO=""`.
126+
You can instruct the `cut-release` target to avoid pushing the tag by passing the
127+
`PUSH_TO=""` option. For example, `make cut-release BUMP_TO_VERSION="0.1.2" PUSH_TO=""`.
128128

129-
* Go to <https://github.com/mongodb/snooty-parser/releases/> to locate the newly-created
130-
release.
129+
4. Go to <https://github.com/mongodb/snooty-parser/releases/> to locate the newly-created
130+
release.
131131

132-
* Copy the appropriate section from CHANGELOG.md into the release description, and
133-
check the _This is a pre-release_ checkbox.
132+
5. Copy the appropriate section from CHANGELOG.md into the release description, and
133+
check the _This is a pre-release_ checkbox.
134134

135135
If there is an error, use `git reset --hard <previous_commit_hash>` to revert any
136136
commits that might have been made, and

0 commit comments

Comments
 (0)