Skip to content

Component proper setter/getter, constructor may set its author, normalize optional version #247

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

Merged
jkowalleck merged 7 commits into from
Feb 2, 2022
Merged

Component proper setter/getter, constructor may set its author, normalize optional version #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
38c57ed
Component rework
jkowalleck Jan 26, 2022
41c5387
use `@babel/eslint-parser`
jkowalleck Jan 29, 2022
5603c70
update locked dependencies and lockfile format
jkowalleck Jan 29, 2022
fe6ccfd
CT/CI generates jsdoc & play with jsdoc
jkowalleck Jan 29, 2022
e5ce5c0
wrote history
jkowalleck Jan 29, 2022
02534e4
slacked components getterusage internally
jkowalleck Jan 30, 2022
17b43c4
fixed JSDoc `object` annotation
jkowalleck Jan 30, 2022
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
27 changes: 25 additions & 2 deletions .github/workflows/nodejs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ jobs:
node-version:
# action based on https://github.com/actions/node-versions/releases
# see also: https://nodejs.org/en/about/releases/
- "16" # active LTS
- "17" # current
Comment thread
jkowalleck marked this conversation as resolved.
- "16" # active LTS
- "14"
- "12" # lowest supported
- "12"
- "12.0.0" # lowest supported
env:
REPORTS_ARTIFACT: tests-reports
steps:
Expand All @@ -44,6 +46,8 @@ jobs:
node-version: ${{ matrix.node-version }}
cache: "npm"
cache-dependency-path: "**/package-lock.json"
- name: display node version
run: node --version
- name: install project
run: npm ci
- name: install testing-project "with-packages"
Expand Down Expand Up @@ -99,3 +103,22 @@ jobs:
- name: run tests
run: npm run test:standard

jsdoc:
name: JSDoc
timeout-minutes: 30
runs-on: "ubuntu-latest"
steps:
- name: Checkout
# see https://github.com/actions/checkout
uses: actions/checkout@v2.4.0
- name: Setup Node.js ${{ env.NODE_ACTIVE_LTS }}
# see https://github.com/actions/setup-node
uses: actions/setup-node@v2.5.1
with:
node-version: ${{ env.NODE_ACTIVE_LTS }}
cache: "npm"
cache-dependency-path: "**/package-lock.json"
- name: install project
run: npm ci
- name: generate JSDoc
run: npm run generate-jsdocs
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ node_modules/
/reports/
/CI_reports/

## target of JSDoc
/out/
/docs/jsdoc/

## caches
/.*.cache

Expand Down
15 changes: 15 additions & 0 deletions HISTORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@ All notable changes to this project will be documented in this file.

## unreleased

* Changed
* Private/protected properties of Component models are no longer directly accessible. ([#233] via [#247])
Access via public getter/setter.
* Fixed
* Normalization guarantees `component.version`. ([#248] via [#247])
* Component's constructor may detect & set `autor` based on package info. ([#246] via [#247])
* Added
* JSDoc for Component model. ([#220] via [#247])

[#220]: https://github.com/CycloneDX/cyclonedx-node-module/issues/220
[#233]: https://github.com/CycloneDX/cyclonedx-node-module/issues/233
[#246]: https://github.com/CycloneDX/cyclonedx-node-module/issues/246
[#247]: https://github.com/CycloneDX/cyclonedx-node-module/pull/247
[#248]: https://github.com/CycloneDX/cyclonedx-node-module/issues/248

## 3.3.1 - 2021-12-11

* Fixed
Expand Down
Loading