Skip to content

Commit

Permalink
fix: Revert accidental change of MERMAID_RELEASE_VERSION
Browse files Browse the repository at this point in the history
  • Loading branch information
sidharthv96 committed Aug 24, 2024
1 parent 9527427 commit c95e997
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/community/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,9 +370,9 @@ If the users have no way to know that things have changed, then you haven't real
Likewise, if users don't know that there is a new feature that you've implemented, it will forever remain unknown and unused.

The documentation has to be updated for users to know that things have been changed and added!
If you are adding a new feature, add `(v10.8.0+)` in the title or description. It will be replaced automatically with the current version number when the release happens.
If you are adding a new feature, add `(vMERMAID_RELEASE_VERSION+)` in the title or description. It will be replaced automatically with the current version number when the release happens.

eg: `# Feature Name (v10.8.0+)`
eg: `# Feature Name (vMERMAID_RELEASE_VERSION+)`

We know it can sometimes be hard to code _and_ write user documentation.

Expand Down
10 changes: 5 additions & 5 deletions packages/mermaid/scripts/update-release-version.mts
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@
* So contributors adding new features will only have to add the placeholder and not worry about updating the version number.
*
*/
import { writeFile } from 'fs/promises';
import { posix } from 'path';
import {
getGlobs,
getFilesFromGlobs,
SOURCE_DOCS_DIR,
readSyncedUTF8file,
getGlobs,
MERMAID_RELEASE_VERSION,
readSyncedUTF8file,
SOURCE_DOCS_DIR,
} from './docs.mjs';
import { writeFile } from 'fs/promises';

const verifyOnly: boolean = process.argv.includes('--verify');
const versionPlaceholder = '<MERMAID_RELEASE_VERSION>';

const main = async () => {
const sourceDirGlob = posix.join('.', SOURCE_DOCS_DIR, '**');
const mdFileGlobs = getGlobs([posix.join(sourceDirGlob, '*.md')]);
mdFileGlobs.push('!**/community/development.md', '!**/community/code.md');
mdFileGlobs.push('!**/community/contributing.md');
const mdFiles = await getFilesFromGlobs(mdFileGlobs);
mdFiles.sort();
const mdFilesWithPlaceholder: string[] = [];
Expand Down
4 changes: 2 additions & 2 deletions packages/mermaid/src/docs/community/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -371,9 +371,9 @@ If the users have no way to know that things have changed, then you haven't real
Likewise, if users don't know that there is a new feature that you've implemented, it will forever remain unknown and unused.

The documentation has to be updated for users to know that things have been changed and added!
If you are adding a new feature, add `(v10.8.0+)` in the title or description. It will be replaced automatically with the current version number when the release happens.
If you are adding a new feature, add `(vMERMAID_RELEASE_VERSION+)` in the title or description. It will be replaced automatically with the current version number when the release happens.

eg: `# Feature Name (v10.8.0+)`
eg: `# Feature Name (vMERMAID_RELEASE_VERSION+)`

We know it can sometimes be hard to code _and_ write user documentation.

Expand Down

0 comments on commit c95e997

Please sign in to comment.