You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+4-8Lines changed: 4 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -4,21 +4,17 @@ published: false
4
4
5
5
# Docs
6
6
7
-
This folder structure contains the markdown files that becomes the Sinon.JS documentation site published to GitHub Pages. Eventually this will replace the current site at https://sinonjs.org.
7
+
This folder structure contains the markdown files that is the Sinon.JS documentation site published to GitHub Pages.
8
8
9
9
See [CONTRIBUTING.md](CONTRIBUTING.md) for details on contributing documentation to Sinon.JS. This file also lists how to run the site locally.
10
10
11
11
## Documentation release process
12
12
13
-
Whenever a new release is created using `npm version`, the tree from `release-source/release/` is copied into its own folder under `releases/` with an appropriate name.
14
-
13
+
Whenever a new release is created using `npm version`, the tree from `release-source/release/` is copied into a folder under `releases/` with an appropriate name.
15
14
Likewise, the `_releases/release.md` file is copied into a file matching the release name.
16
15
17
-
### Example
18
-
19
-
Let's say that we're making a new `v2.0.3` release.
16
+
Currently, we keep a single folder per major release.
20
17
21
-
-`release-source/release/` is copied into a new folder `_releases/v2.0.3/`
22
-
-`release-source/release.md` is copied into a new file `_releases/v2.0.3.md`
18
+
See `scripts/postversion.sh` for details on the exact process, as it changes over time.
23
19
24
20
The release is packaged, tagged and pushed to GitHub. GitHub Pages will build a new site in a few minutes, and replace the old one.
0 commit comments