Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Commit

Permalink
Merge pull request #156 from lognaturel/release
Browse files Browse the repository at this point in the history
  • Loading branch information
lognaturel committed Dec 14, 2022
2 parents 18d99ee + 77e5f44 commit e9aaf17
Show file tree
Hide file tree
Showing 16 changed files with 593 additions and 157 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [2.1.7] - 2022-12-14

##### Changed

- Replace request with undici (Node's official fetch package), update dependencies, patch vulnerabilities (#155)

## [2.1.6] - 2022-10-27

##### Changed
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,17 +119,17 @@ DEBUG=api,transformer,markdown,language node app.js
Releases are done each time a dependent tool needs an `enketo-transformer` change.

1. Create release PR
1. Update `CHANGELOG.md`
1. Update version in `package.json`
- Bump to major version if downstream has to make changes.
1. Check [Dependabot](https://github.com/enketo/enketo-transformer/security/dependabot) for alerts
1. Run `npm update`
- Check if `node-libxslt` has been updated because it has caused problems in the past
1. Run `npm audit`
- Run `npm audit fix --production` to apply most important fixes
1. Run `npm ci`
1. Run `npm i`
1. Run `npm test`
1. Run `npm run build-docs`
1. Update `CHANGELOG.md`
1. Update version in `package.json`
- Bump to major version if downstream has to make changes.
1. Merge PR with all changes
1. Create GitHub release
1. Tag and publish the release
Expand Down
235 changes: 119 additions & 116 deletions docs/api.js.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/global.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

<input type="text" id="nav-search" placeholder="Search" />

<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/enketo/enketo-transformer" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><h2><a href="https://github.com/enketo/enketo-transformer/blob/master/CHANGELOG.md" target="_blank" class="menu-item" id="change-log" >Change log</a></h2><h3>Modules</h3><ul><li><a href="module-api.html">api</a><ul class='methods'><li data-type='method'><a href="module-api.html#~_request">_request</a></li></ul></li><li><a href="module-language.html">language</a><ul class='methods'><li data-type='method'><a href="module-language.html#.parse">parse</a></li><li data-type='method'><a href="module-language.html#~_getDirectionality">_getDirectionality</a></li><li data-type='method'><a href="module-language.html#~_getLangWithDesc">_getLangWithDesc</a></li><li data-type='method'><a href="module-language.html#~_getLangWithTag">_getLangWithTag</a></li><li data-type='method'><a href="module-language.html#~_languagesOnly">_languagesOnly</a></li></ul></li><li><a href="module-markdown.html">markdown</a><ul class='methods'><li data-type='method'><a href="module-markdown.html#.markdownToHtml">markdownToHtml</a></li><li data-type='method'><a href="module-markdown.html#~_createHeader">_createHeader</a></li><li data-type='method'><a href="module-markdown.html#~_createItem">_createItem</a></li><li data-type='method'><a href="module-markdown.html#~_createOrderedList">_createOrderedList</a></li><li data-type='method'><a href="module-markdown.html#~_createParagraph">_createParagraph</a></li><li data-type='method'><a href="module-markdown.html#~_createSpan">_createSpan</a></li><li data-type='method'><a href="module-markdown.html#~_createSub">_createSub</a></li><li data-type='method'><a href="module-markdown.html#~_createSup">_createSup</a></li><li data-type='method'><a href="module-markdown.html#~_createUnorderedList">_createUnorderedList</a></li><li data-type='method'><a href="module-markdown.html#~_sanitizeAttributes">_sanitizeAttributes</a></li></ul></li><li><a href="module-transformer.html">transformer</a><ul class='members'><li data-type='member'><a href="module-transformer.html#.NAMESPACES">NAMESPACES</a></li><li data-type='member'><a href="module-transformer.html#.version">version</a></li><li data-type='member'><a href="module-transformer.html#~htmlStr">htmlStr</a></li></ul><ul class='methods'><li data-type='method'><a href="module-transformer.html#.transform">transform</a></li><li data-type='method'><a href="module-transformer.html#~_addInstanceIdNodeIfMissing">_addInstanceIdNodeIfMissing</a></li><li data-type='method'><a href="module-transformer.html#~_correctAction">_correctAction</a></li><li data-type='method'><a href="module-transformer.html#~_docToString">_docToString</a></li><li data-type='method'><a href="module-transformer.html#~_getLanguageSampleText">_getLanguageSampleText</a></li><li data-type='method'><a href="module-transformer.html#~_getVersion">_getVersion</a></li><li data-type='method'><a href="module-transformer.html#~_md5">_md5</a></li><li data-type='method'><a href="module-transformer.html#~_parseXml">_parseXml</a></li><li data-type='method'><a href="module-transformer.html#~_processBinaryDefaults">_processBinaryDefaults</a></li><li data-type='method'><a href="module-transformer.html#~_renderMarkdown">_renderMarkdown</a></li><li data-type='method'><a href="module-transformer.html#~_replaceLanguageTags">_replaceLanguageTags</a></li><li data-type='method'><a href="module-transformer.html#~_replaceMediaSources">_replaceMediaSources</a></li><li data-type='method'><a href="module-transformer.html#~_replaceTheme">_replaceTheme</a></li><li data-type='method'><a href="module-transformer.html#~_transform">_transform</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#escapeURLPath">escapeURLPath</a></li><li><a href="global.html#getMediaPath">getMediaPath</a></li></ul>
<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/enketo/enketo-transformer" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><h2><a href="https://github.com/enketo/enketo-transformer/blob/master/CHANGELOG.md" target="_blank" class="menu-item" id="change-log" >Change log</a></h2><h3>Classes</h3><ul><li><a href="module-api-FetchError.html">api~FetchError</a></li></ul><h3>Modules</h3><ul><li><a href="module-api.html">api</a><ul class='methods'><li data-type='method'><a href="module-api.html#~getTransformedSurvey">getTransformedSurvey</a></li><li data-type='method'><a href="module-api.html#~getXForm">getXForm</a></li></ul></li><li><a href="module-language.html">language</a><ul class='methods'><li data-type='method'><a href="module-language.html#.parse">parse</a></li><li data-type='method'><a href="module-language.html#~_getDirectionality">_getDirectionality</a></li><li data-type='method'><a href="module-language.html#~_getLangWithDesc">_getLangWithDesc</a></li><li data-type='method'><a href="module-language.html#~_getLangWithTag">_getLangWithTag</a></li><li data-type='method'><a href="module-language.html#~_languagesOnly">_languagesOnly</a></li></ul></li><li><a href="module-markdown.html">markdown</a><ul class='methods'><li data-type='method'><a href="module-markdown.html#.markdownToHtml">markdownToHtml</a></li><li data-type='method'><a href="module-markdown.html#~_createHeader">_createHeader</a></li><li data-type='method'><a href="module-markdown.html#~_createItem">_createItem</a></li><li data-type='method'><a href="module-markdown.html#~_createOrderedList">_createOrderedList</a></li><li data-type='method'><a href="module-markdown.html#~_createParagraph">_createParagraph</a></li><li data-type='method'><a href="module-markdown.html#~_createSpan">_createSpan</a></li><li data-type='method'><a href="module-markdown.html#~_createSub">_createSub</a></li><li data-type='method'><a href="module-markdown.html#~_createSup">_createSup</a></li><li data-type='method'><a href="module-markdown.html#~_createUnorderedList">_createUnorderedList</a></li><li data-type='method'><a href="module-markdown.html#~_sanitizeAttributes">_sanitizeAttributes</a></li></ul></li><li><a href="module-transformer.html">transformer</a><ul class='members'><li data-type='member'><a href="module-transformer.html#.NAMESPACES">NAMESPACES</a></li><li data-type='member'><a href="module-transformer.html#.version">version</a></li><li data-type='member'><a href="module-transformer.html#~htmlStr">htmlStr</a></li></ul><ul class='methods'><li data-type='method'><a href="module-transformer.html#.transform">transform</a></li><li data-type='method'><a href="module-transformer.html#~_addInstanceIdNodeIfMissing">_addInstanceIdNodeIfMissing</a></li><li data-type='method'><a href="module-transformer.html#~_correctAction">_correctAction</a></li><li data-type='method'><a href="module-transformer.html#~_docToString">_docToString</a></li><li data-type='method'><a href="module-transformer.html#~_getLanguageSampleText">_getLanguageSampleText</a></li><li data-type='method'><a href="module-transformer.html#~_getVersion">_getVersion</a></li><li data-type='method'><a href="module-transformer.html#~_md5">_md5</a></li><li data-type='method'><a href="module-transformer.html#~_parseXml">_parseXml</a></li><li data-type='method'><a href="module-transformer.html#~_processBinaryDefaults">_processBinaryDefaults</a></li><li data-type='method'><a href="module-transformer.html#~_renderMarkdown">_renderMarkdown</a></li><li data-type='method'><a href="module-transformer.html#~_replaceLanguageTags">_replaceLanguageTags</a></li><li data-type='method'><a href="module-transformer.html#~_replaceMediaSources">_replaceMediaSources</a></li><li data-type='method'><a href="module-transformer.html#~_replaceTheme">_replaceTheme</a></li><li data-type='method'><a href="module-transformer.html#~_transform">_transform</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#escapeURLPath">escapeURLPath</a></li><li><a href="global.html#getMediaPath">getMediaPath</a></li></ul>
</nav>

<div id="main">
Expand Down Expand Up @@ -449,7 +449,7 @@ <h5>Parameters:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

<input type="text" id="nav-search" placeholder="Search" />

<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/enketo/enketo-transformer" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><h2><a href="https://github.com/enketo/enketo-transformer/blob/master/CHANGELOG.md" target="_blank" class="menu-item" id="change-log" >Change log</a></h2><h3>Modules</h3><ul><li><a href="module-api.html">api</a><ul class='methods'><li data-type='method'><a href="module-api.html#~_request">_request</a></li></ul></li><li><a href="module-language.html">language</a><ul class='methods'><li data-type='method'><a href="module-language.html#.parse">parse</a></li><li data-type='method'><a href="module-language.html#~_getDirectionality">_getDirectionality</a></li><li data-type='method'><a href="module-language.html#~_getLangWithDesc">_getLangWithDesc</a></li><li data-type='method'><a href="module-language.html#~_getLangWithTag">_getLangWithTag</a></li><li data-type='method'><a href="module-language.html#~_languagesOnly">_languagesOnly</a></li></ul></li><li><a href="module-markdown.html">markdown</a><ul class='methods'><li data-type='method'><a href="module-markdown.html#.markdownToHtml">markdownToHtml</a></li><li data-type='method'><a href="module-markdown.html#~_createHeader">_createHeader</a></li><li data-type='method'><a href="module-markdown.html#~_createItem">_createItem</a></li><li data-type='method'><a href="module-markdown.html#~_createOrderedList">_createOrderedList</a></li><li data-type='method'><a href="module-markdown.html#~_createParagraph">_createParagraph</a></li><li data-type='method'><a href="module-markdown.html#~_createSpan">_createSpan</a></li><li data-type='method'><a href="module-markdown.html#~_createSub">_createSub</a></li><li data-type='method'><a href="module-markdown.html#~_createSup">_createSup</a></li><li data-type='method'><a href="module-markdown.html#~_createUnorderedList">_createUnorderedList</a></li><li data-type='method'><a href="module-markdown.html#~_sanitizeAttributes">_sanitizeAttributes</a></li></ul></li><li><a href="module-transformer.html">transformer</a><ul class='members'><li data-type='member'><a href="module-transformer.html#.NAMESPACES">NAMESPACES</a></li><li data-type='member'><a href="module-transformer.html#.version">version</a></li><li data-type='member'><a href="module-transformer.html#~htmlStr">htmlStr</a></li></ul><ul class='methods'><li data-type='method'><a href="module-transformer.html#.transform">transform</a></li><li data-type='method'><a href="module-transformer.html#~_addInstanceIdNodeIfMissing">_addInstanceIdNodeIfMissing</a></li><li data-type='method'><a href="module-transformer.html#~_correctAction">_correctAction</a></li><li data-type='method'><a href="module-transformer.html#~_docToString">_docToString</a></li><li data-type='method'><a href="module-transformer.html#~_getLanguageSampleText">_getLanguageSampleText</a></li><li data-type='method'><a href="module-transformer.html#~_getVersion">_getVersion</a></li><li data-type='method'><a href="module-transformer.html#~_md5">_md5</a></li><li data-type='method'><a href="module-transformer.html#~_parseXml">_parseXml</a></li><li data-type='method'><a href="module-transformer.html#~_processBinaryDefaults">_processBinaryDefaults</a></li><li data-type='method'><a href="module-transformer.html#~_renderMarkdown">_renderMarkdown</a></li><li data-type='method'><a href="module-transformer.html#~_replaceLanguageTags">_replaceLanguageTags</a></li><li data-type='method'><a href="module-transformer.html#~_replaceMediaSources">_replaceMediaSources</a></li><li data-type='method'><a href="module-transformer.html#~_replaceTheme">_replaceTheme</a></li><li data-type='method'><a href="module-transformer.html#~_transform">_transform</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#escapeURLPath">escapeURLPath</a></li><li><a href="global.html#getMediaPath">getMediaPath</a></li></ul>
<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/enketo/enketo-transformer" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><h2><a href="https://github.com/enketo/enketo-transformer/blob/master/CHANGELOG.md" target="_blank" class="menu-item" id="change-log" >Change log</a></h2><h3>Classes</h3><ul><li><a href="module-api-FetchError.html">api~FetchError</a></li></ul><h3>Modules</h3><ul><li><a href="module-api.html">api</a><ul class='methods'><li data-type='method'><a href="module-api.html#~getTransformedSurvey">getTransformedSurvey</a></li><li data-type='method'><a href="module-api.html#~getXForm">getXForm</a></li></ul></li><li><a href="module-language.html">language</a><ul class='methods'><li data-type='method'><a href="module-language.html#.parse">parse</a></li><li data-type='method'><a href="module-language.html#~_getDirectionality">_getDirectionality</a></li><li data-type='method'><a href="module-language.html#~_getLangWithDesc">_getLangWithDesc</a></li><li data-type='method'><a href="module-language.html#~_getLangWithTag">_getLangWithTag</a></li><li data-type='method'><a href="module-language.html#~_languagesOnly">_languagesOnly</a></li></ul></li><li><a href="module-markdown.html">markdown</a><ul class='methods'><li data-type='method'><a href="module-markdown.html#.markdownToHtml">markdownToHtml</a></li><li data-type='method'><a href="module-markdown.html#~_createHeader">_createHeader</a></li><li data-type='method'><a href="module-markdown.html#~_createItem">_createItem</a></li><li data-type='method'><a href="module-markdown.html#~_createOrderedList">_createOrderedList</a></li><li data-type='method'><a href="module-markdown.html#~_createParagraph">_createParagraph</a></li><li data-type='method'><a href="module-markdown.html#~_createSpan">_createSpan</a></li><li data-type='method'><a href="module-markdown.html#~_createSub">_createSub</a></li><li data-type='method'><a href="module-markdown.html#~_createSup">_createSup</a></li><li data-type='method'><a href="module-markdown.html#~_createUnorderedList">_createUnorderedList</a></li><li data-type='method'><a href="module-markdown.html#~_sanitizeAttributes">_sanitizeAttributes</a></li></ul></li><li><a href="module-transformer.html">transformer</a><ul class='members'><li data-type='member'><a href="module-transformer.html#.NAMESPACES">NAMESPACES</a></li><li data-type='member'><a href="module-transformer.html#.version">version</a></li><li data-type='member'><a href="module-transformer.html#~htmlStr">htmlStr</a></li></ul><ul class='methods'><li data-type='method'><a href="module-transformer.html#.transform">transform</a></li><li data-type='method'><a href="module-transformer.html#~_addInstanceIdNodeIfMissing">_addInstanceIdNodeIfMissing</a></li><li data-type='method'><a href="module-transformer.html#~_correctAction">_correctAction</a></li><li data-type='method'><a href="module-transformer.html#~_docToString">_docToString</a></li><li data-type='method'><a href="module-transformer.html#~_getLanguageSampleText">_getLanguageSampleText</a></li><li data-type='method'><a href="module-transformer.html#~_getVersion">_getVersion</a></li><li data-type='method'><a href="module-transformer.html#~_md5">_md5</a></li><li data-type='method'><a href="module-transformer.html#~_parseXml">_parseXml</a></li><li data-type='method'><a href="module-transformer.html#~_processBinaryDefaults">_processBinaryDefaults</a></li><li data-type='method'><a href="module-transformer.html#~_renderMarkdown">_renderMarkdown</a></li><li data-type='method'><a href="module-transformer.html#~_replaceLanguageTags">_replaceLanguageTags</a></li><li data-type='method'><a href="module-transformer.html#~_replaceMediaSources">_replaceMediaSources</a></li><li data-type='method'><a href="module-transformer.html#~_replaceTheme">_replaceTheme</a></li><li data-type='method'><a href="module-transformer.html#~_transform">_transform</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#escapeURLPath">escapeURLPath</a></li><li><a href="global.html#getMediaPath">getMediaPath</a></li></ul>
</nav>

<div id="main">
Expand Down Expand Up @@ -213,7 +213,7 @@ <h3 id="change-log">Change Log</h3>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
Loading

0 comments on commit e9aaf17

Please sign in to comment.