Skip to content

build: add workflow to generate monthly changelog #5983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 11 commits into from
Apr 24, 2025
Merged

build: add workflow to generate monthly changelog #5983

merged 11 commits into from
Apr 24, 2025

Conversation

@Planeshifter
Copy link
Member

@Planeshifter Planeshifter commented Mar 12, 2025 •
edited
Loading

Description

What is the purpose of this pull request?

This pull request:

  • adds support for specifying options for the underlying git log command used to retrieve the commits for which to parse commits and generate a changelog for, respectively.
  • adds a workflow that generates a monthly changelog and pushes it to the www-blog-monthly-changelog repository.

Related Issues

Does this pull request have any related issues?

This pull request:

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

@stdlib-js/reviewers

@stdlib-bot stdlib-bot added the Tools Issue or pull request related to project tooling. label Mar 12, 2025
@Planeshifter
build: add option to parse-commits utility to set git log flags
f907f8c 
---
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: passed
  - 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: passed
  - 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
---
@Planeshifter
build: tweak output when flags are supplied and add workflow
ef6719e 
---
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: passed
  - 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: na
  - 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
---
@Planeshifter Planeshifter force-pushed the philipp/monthly-changelog-issue branch from 2bf7851 to ef6719e Compare March 15, 2025 02:37
@Planeshifter Planeshifter changed the title build: add option to parse-commits and changelog generation utility to set git log flags build: add workflow to generate monthly changelog Mar 15, 2025
@Planeshifter Planeshifter mentioned this pull request Mar 15, 2025
Closed
@Planeshifter Planeshifter requested a review from kgryte March 25, 2025 08:34
@Planeshifter Planeshifter marked this pull request as ready for review March 25, 2025 08:34
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Mar 25, 2025
kgryte
kgryte reviewed Apr 16, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 16, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 16, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 16, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 16, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 16, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 16, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 16, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 16, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 16, 2025
View reviewed changes
@kgryte kgryte added Needs Changes Pull request which needs changes before being merged. CI Issue or pull request specific to continuous integration environments. and removed Needs Review A pull request which needs code review. labels Apr 16, 2025
Planeshifter and others added 2 commits April 19, 2025 17:26
@Planeshifter @kgryte
chore: apply suggestions from code review
7c0695e 
Co-authored-by: Athan <kgryte@gmail.com>
Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>
@Planeshifter
chore: address PR review feedback
c3ef633 
---
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
---
@Planeshifter
build: add format option to changelog generation
944d150 
---
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: passed
  - 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: failed
---
kgryte
kgryte reviewed Apr 20, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 20, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 20, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 20, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 20, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 20, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 20, 2025
View reviewed changes
Planeshifter and others added 3 commits April 22, 2025 21:23
@Planeshifter @kgryte
chore: apply suggestions from code review
b2fcb9b 
Co-authored-by: Athan <kgryte@gmail.com>
Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>
@Planeshifter
chore: address PR review feedback
28bf7ac 
---
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: passed
  - 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: na
  - 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
---
@Planeshifter
chore: remove lint directive
5a94944 
---
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: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - 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: passed
  - 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: na
---
@Planeshifter Planeshifter requested a review from kgryte April 23, 2025 01:37
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Apr 23, 2025
kgryte
kgryte reviewed Apr 23, 2025
View reviewed changes
kgryte
kgryte reviewed Apr 23, 2025
View reviewed changes
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from the one stray TODO, this is looking good.

@kgryte
Copy link
Member

kgryte commented Apr 23, 2025

Also, is there a way to avoid the examples CI failures?

@kgryte kgryte removed the Needs Review A pull request which needs code review. label Apr 23, 2025
@Planeshifter
docs: add description for aggregated format
a81d07c 
---
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: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - 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: passed
  - 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: na
---
@Planeshifter
Copy link
Member Author

Planeshifter commented Apr 24, 2025

@kgryte We don't have a way to omit example code blocks from being run, do we? I believe the problem is that we only checkout a limited number of commits in the workflow and the examples do not work without the commit history. Locally they run without problems for me.

@kgryte
Copy link
Member

kgryte commented Apr 24, 2025

Yes, you use the run-disable directive.

@Planeshifter
Copy link
Member Author

Planeshifter commented Apr 24, 2025

@kgryte Great, wasn't sure whether it was also honored by the make recipes for running examples. Will add.

@Planeshifter
chore: add directives to disable running examples
2250083 
---
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: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - 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
---
kgryte
kgryte reviewed Apr 24, 2025
View reviewed changes
@kgryte
docs: update copy
e70076b 
Signed-off-by: Athan <kgryte@gmail.com>
@kgryte kgryte removed the Needs Changes Pull request which needs changes before being merged. label Apr 24, 2025
@kgryte kgryte merged commit f23d66e into develop Apr 24, 2025
10 checks passed
@kgryte kgryte deleted the philipp/monthly-changelog-issue branch April 24, 2025 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kgryte kgryte kgryte approved these changes

Assignees

No one assigned

Labels

CI Issue or pull request specific to continuous integration environments. Tools Issue or pull request related to project tooling.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[RFC]: Add support for generating a monthly summary and analysis of Git history and automatically generate a monthly changelog

4 participants

@Planeshifter @kgryte @stdlib-bot