Skip to content

Commit c3ef633

Browse files
committed
chore: address PR review feedback
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: passed ---
1 parent 7c0695e commit c3ef633

File tree

4 files changed

+8
-5
lines changed

4 files changed

+8
-5
lines changed

.github/workflows/generate_monthly_changelog.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ jobs:
7979
# Pin action to full length commit SHA
8080
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
8181
with:
82-
# Code coverage repository:
82+
# Monthly changelog repository:
8383
repository: 'stdlib-js/www-blog-monthly-changelog'
8484

8585
# File path to checkout to:

lib/node_modules/@stdlib/_tools/changelog/generate/test/test.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,9 @@ tape( 'the function generates a changelog for a new release (auto)', function te
170170

171171
tape( 'the function generates a changelog for a specific author', function test( t ) {
172172
var out = generate( '@stdlib/ndarray/base', {
173-
'flags': '--author="Athan Reines"'
173+
'flags': {
174+
'author': 'Athan Reines <[email protected]>'
175+
}
174176
});
175177
t.strictEqual( isObject( out ), true, 'returns expected value' );
176178
t.strictEqual( typeof out.content, 'string', 'returns expected value' );

lib/node_modules/@stdlib/_tools/changelog/parse-commits/lib/commits.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ var spawn = require( 'child_process' ).spawnSync; // eslint-disable-line node/no
2626
var logger = require( 'debug' );
2727
var parse = require( 'yaml' ).parse;
2828
var substringAfter = require( '@stdlib/string/substring-after' );
29+
var objectKeys = require( '@stdlib/utils/keys' );
2930
var replace = require( '@stdlib/string/replace' );
3031
var trim = require( '@stdlib/string/trim' );
3132
var filterFiles = require( './filter_files.js' );
@@ -76,7 +77,7 @@ function extractYAMLBlock( str ) {
7677
*
7778
* @private
7879
* @param {string} dir - directory for which to extract commit details
79-
* @param {string} flags - `git log` options
80+
* @param {Object} flags - `git log` options
8081
* @returns {Array} array of commit details
8182
*
8283
* @example
@@ -113,7 +114,7 @@ function extractCommits( dir, flags ) {
113114
commits = [];
114115
args = [ resolve( dir ) ];
115116
if ( flags ) {
116-
flagNames = Object.keys( flags );
117+
flagNames = objectKeys( flags );
117118
for ( i = 0; i < flagNames.length; i++ ) {
118119
args.push( '--'+flagNames[i]+'='+flags[ flagNames[ i ] ] );
119120
}

lib/node_modules/@stdlib/_tools/changelog/parse-commits/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ var debug = logger( 'changelog:parse-commits' );
4545
* @param {string} [options.dir] - root directory
4646
* @param {string} [options.issueURL] - issue URL
4747
* @param {string} [options.prURL] - PR URL
48-
* @param {string} [options.flags] - `git log` options
48+
* @param {Object} [options.flags] - `git log` options
4949
* @throws {TypeError} options argument must be an object
5050
* @throws {TypeError} must provide valid options
5151
* @returns {Array} array of conventional changelog formatted commit message objects

0 commit comments

Comments
 (0)