Skip to content

Commit e07319e

Browse files
committed
Try to fix MkDocs rendering
1 parent 1ac8dad commit e07319e

File tree

1 file changed

+40
-36
lines changed

1 file changed

+40
-36
lines changed

doc/maintainers/releases.md

Lines changed: 40 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,20 @@ Examples:
4646
* `1.7.0.3`: second release candidate for first release of v1.7.x series (`v1.7`
4747
branch)
4848

49+
4950
* `1.7.1`: first release of the 1.7.x series (`release` branch)
5051

52+
5153
* `1.7.2.0`: development for second release of 1.7.x series (`stable` branch)
5254
* `1.7.2.1`: release candidate for second release of 1.7.x series (`stable`
5355
branch)
5456

57+
5558
* `1.7.3`: second release of 1.7.x series (`release` branch)
5659
* `1.7.3.1`: first hackage-only patch of 1.7.3 (`release` branch)
5760
* `1.7.3.2`: second hackage-only patch of 1.7.3 (`release` branch)
5861

62+
5963
* `1.8.0`: unstable development code (`master` branch)
6064
* `1.8.0.20181004`: pre-release snapshot of unstable version (`master` branch)
6165

@@ -72,9 +76,9 @@ Examples:
7276
nightly (go over the extra-deps too) and ensure the project builds and tests
7377
pass. For example:
7478

75-
~~~
76-
$ stack build --stack-yaml=… --haddock --test --bench --no-run-benchmarks
77-
~~~
79+
~~~
80+
$ stack build --stack-yaml=… --haddock --test --bench --no-run-benchmarks
81+
~~~
7882
7. Ensure integration tests pass on a Windows, macOS, and Linux. Do so by
7983
checking that the latest nightly build for the `master` branch succeeded in
8084
Azure DevOps (or kick one off manually if any significant changes were made
@@ -107,21 +111,21 @@ branch.
107111
will be the next final (non-RC) release (e.g. `v2.1.1`).
108112
* add new "Unreleased changes" section:
109113
110-
```
111-
## Unreleased changes
114+
~~~
115+
## Unreleased changes
112116
113-
Release notes:
117+
Release notes:
114118
115-
**Changes since vX.Y.Z:**
119+
**Changes since vX.Y.Z:**
116120
117-
Major changes:
121+
Major changes:
118122
119-
Behavior changes:
123+
Behavior changes:
120124
121-
Other enhancements:
125+
Other enhancements:
122126
123-
Bug fixes:
124-
```
127+
Bug fixes:
128+
~~~
125129
126130
### D: In the release candidate branch
127131
@@ -229,9 +233,9 @@ Edit the draft
229233
* For final releases (**not** release candidates) get the list of contributors
230234
to the release and add it to the description. For example, use:
231235
232-
~~~
233-
$ git shortlog -s origin/release..HEAD|sed $'s/^[0-9 \t]*/* /'|grep -v azure-pipelines|LC_ALL=C sort -f
234-
~~~
236+
~~~
237+
$ git shortlog -s origin/release..HEAD|sed $'s/^[0-9 \t]*/* /'|grep -v azure-pipelines|LC_ALL=C sort -f
238+
~~~
235239
236240
Publish the GitHub release.
237241
@@ -304,21 +308,21 @@ In either the `stable` branch or, in the case of a release candidate, the
304308
* `ChangeLog.md`: Add an “Unreleased changes” section (update the “changes
305309
since” version):
306310
307-
~~~
308-
## Unreleased changes
311+
~~~
312+
## Unreleased changes
309313
310-
Release notes:
314+
Release notes:
311315
312-
**Changes since vX.Y.Z:**
316+
**Changes since vX.Y.Z:**
313317
314-
Major changes:
318+
Major changes:
315319
316-
Behavior changes:
320+
Behavior changes:
317321
318-
Other enhancements:
322+
Other enhancements:
319323
320-
Bug fixes:
321-
~~~
324+
Bug fixes:
325+
~~~
322326
323327
### G: Update the repository's issue and pull request templates
324328
@@ -353,22 +357,22 @@ Update the fpco/stack-build Docker images with new version:
353357
containing (where `X.Z` is the previous LTS version, and `X.Y.Z` is the newly
354358
released Stack version):
355359
356-
~~~
357-
FROM $DOCKER_REPO:lts-X.Z
358-
ARG STACK_VERSION=X.Y.Z
359-
RUN wget -qO- https://github.com/commercialhaskell/stack/releases/download/v$STACK_VERSION/stack-$STACK_VERSION-linux-x86_64.tar.gz | tar xz --wildcards --strip-components=1 -C /usr/local/bin '*/stack'
360-
~~~
360+
~~~
361+
FROM $DOCKER_REPO:lts-X.Z
362+
ARG STACK_VERSION=X.Y.Z
363+
RUN wget -qO- https://github.com/commercialhaskell/stack/releases/download/v$STACK_VERSION/stack-$STACK_VERSION-linux-x86_64.tar.gz | tar xz --wildcards --strip-components=1 -C /usr/local/bin '*/stack'
364+
~~~
361365
362366
* Run `./build.sh lts-X.Y` and then test that the new image has the new version
363367
of Stack. For example:
364368
365-
~~~
366-
$ docker run --rm fpco/stack-build:lts stack --version
367-
~~~
369+
~~~
370+
$ docker run --rm fpco/stack-build:lts stack --version
371+
~~~
368372
369373
* Run the following command to push the new image to the registry:
370374
371-
~~~
372-
$ ./build.sh --push lts-X.Y
373-
$ ./build.sh --push --small lts-X.Y
374-
~~~
375+
~~~
376+
$ ./build.sh --push lts-X.Y
377+
$ ./build.sh --push --small lts-X.Y
378+
~~~

0 commit comments

Comments
 (0)