vndb/mithril-vndb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update release docs [skip ci]

Browse source
This commit is contained in:
Isiah Meadows 2019-08-21 19:01:12 -04:00
parent 8ef0c2cd79
commit c6dc7ebe64
2 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/releasing.md
View file

@ -18,7 +18,8 @@ $ git pull --rebase mithriljs next
``` ```
2. Determine patch level of the change 2. Determine patch level of the change
3. Update information in `docs/change-log.md` to match reality of the new version being prepared for release 3. Update information in `docs/change-log.md` to match reality of the new version being prepared for release.
- Don't forget to add today's date under the version heading!
4. Replace all existing references to `mithril@next` to `mithril` if moving from a release candidate to stable. 4. Replace all existing references to `mithril@next` to `mithril` if moving from a release candidate to stable.
- Note: if making an initial release candidate, don't forget to move all the playground snippets to pull from `mithril@next`! - Note: if making an initial release candidate, don't forget to move all the playground snippets to pull from `mithril@next`!
5. Commit changes to `next` 5. Commit changes to `next`
@ -131,8 +132,10 @@ $ git pull --rebase mithriljs next
``` ```
2. Determine patch level of the change 2. Determine patch level of the change
3. Update `version` field in `ospec/package.json` to match new version being prepared for release 3. Update `version` field in `ospec/package.json` to match new version being prepared for release.
4. Commit changes to `next` 4. Update `ospec/change-log.md` to match new version being prepared for release.
- Don't forget to add today's date under the version heading!
5. Commit changes to `next`
``` ```
$ git add . $ git add .

4
scripts/release.js
View file

@ -123,7 +123,9 @@ async function release({increment, preid, publish}) {
console.error(` console.error(`
Copy the parts listed in "Upcoming" to a new section "### v${version}" in Copy the parts listed in "Upcoming" to a new section "### v${version}" in
docs/change-log.md and clear that section out. docs/change-log.md and clear that section out. Also, add today's date under the
new section's heading to match the others and don't forget to update the table
of contents accordingly.
`) `)
for (;;) { for (;;) {