Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions docs/develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,6 @@ Stardown uses several different execution contexts as described in [./execution-

This project uses [JSDoc](https://en.wikipedia.org/wiki/JSDoc) to annotate types. In VS Code you can type `/**` above a function and press enter to auto-generate part of its JSDoc comment.

## Releasing

When creating a new release:

1. Make sure the tests pass with `npm test`
2. Update the `VERSION` variable in [../src/settings.js](../src/settings.js)
3. Run the `VERSION` block of code in a REPL to make sure the new version is correctly formatted.
4. If the new version is a stable release
1. Update the "version" properties in the manifests
2. Update [../src/updated.html](../src/updated.html)
5. Commit, push, make a pull request into the main branch, merge, and pull
6. Tag the merge commit with the same value as the `VERSION` variable in settings.js
7. Push the tag

This will run a few GitHub actions that will build the extension, create a GitHub release, and update [the install/update instructions site](https://stardown-app.github.io/Stardown/docs/install-and-update-instructions/).

## Improving Stardown's output

If changes to improve the output can apply to:
Expand Down Expand Up @@ -103,3 +87,19 @@ Sample markdown tables for testing markdown renderers can be found in [./sample-
> In this order: optionally a caption element, followed by zero or more colgroup elements, followed optionally by a thead element, followed by either zero or more tbody elements or one or more tr elements, followed optionally by a tfoot element, optionally intermixed with one or more script-supporting elements.
>
> — [the HTML Standard](https://html.spec.whatwg.org/multipage/tables.html)

## Releasing

Here's what I do when creating a new release:

1. Make sure the tests pass with `npm test`
2. Update the `VERSION` variable in [../src/settings.js](../src/settings.js)
3. Run the `VERSION` block of code in a new REPL session to make sure the new version is correctly formatted.
4. If the new version is a stable release
1. Update the "version" properties in the manifests
2. Update [../src/updated.html](../src/updated.html)
5. Commit, push, make a pull request into the main branch, merge, and pull
6. Tag the merge commit with the same value as the `VERSION` variable in settings.js
7. Push the tag

This will run a few GitHub actions that will build the extension, create a GitHub release, and update [the install/update instructions site](https://stardown-app.github.io/Stardown/docs/install-and-update-instructions/).
8 changes: 4 additions & 4 deletions src/settings.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ import { getSetting } from './getSetting.js';

/**
* VERSION is Stardown's version. The value must match one of the regex patterns below;
* you might want to copy & paste this block of code into a REPL to check. This variable
* exists because the "version" properties in the manifests only support stable release
* versions.
* you might want to copy & paste this block of code into a new REPL session to check.
* This variable exists because the "version" properties in the manifests only support
* stable release versions.
*/
const VERSION = 'v2.0.0-alpha.2503020842';
const VERSION = 'v2.0.0-alpha.2503031240';
const stableReleaseTagPattern = /^v\d+\.\d+\.\d+$/;
const prereleaseTagPattern = /^v\d+\.\d+\.\d+-(?:alpha|beta)\.\d{10}$/; // the last 10 digits are YYMMDDhhmm in UTC
if (!stableReleaseTagPattern.test(VERSION) && !prereleaseTagPattern.test(VERSION)) {
Expand Down