Skip to content

Commit af88914

Browse files
authored
v0.1.0 (#38)
* feat: Update to Node 20 and update Lock * feat: Update dist * feat(ci): Update node version * feat(deps): Update dependencies * feat: Fix encoding bug * feat: Update docs and add release * feat: Lint all markdown files
1 parent 9e68cb5 commit af88914

File tree

15 files changed

+31167
-23054
lines changed

15 files changed

+31167
-23054
lines changed

.github/workflows/check-dist.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ jobs:
2323
steps:
2424
- uses: actions/checkout@v4
2525

26-
- name: Set Node.js 16.x
26+
- name: Set Node.js latest
2727
uses: actions/[email protected]
2828
with:
29-
node-version: 16.x
29+
node-version: latest
3030

3131
- name: Install dependencies
3232
run: npm ci

.github/workflows/test.yml

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,33 @@
11
name: "Test"
2+
23
on:
34
pull_request:
45
workflow_dispatch:
56
push:
67
branches:
78
- main
89
- 'releases/*'
9-
workflow_dispatch:
1010

1111
permissions:
1212
id-token: write
1313
contents: write
1414

1515
jobs:
16+
test-npm:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v4
20+
- name: Set Node.js latest
21+
uses: actions/[email protected]
22+
with:
23+
node-version: latest
24+
25+
- run: |
26+
npm ci
27+
# npm run test
28+
1629
# test action works running from the graph
17-
test:
30+
test-action:
1831
runs-on: ubuntu-latest
1932
steps:
2033
- uses: actions/checkout@v4

.release.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: "spdx-dependency-submission-action"
2+
version: 0.1.0
3+
4+
locations:
5+
- name: "Docs"
6+
paths:
7+
- "README.md"
8+
patterns:
9+
- 'advanced-security/spdx-dependency-submission-action@v([0-9]\.[0-9]\.[0-9])'

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
5555
## Enforcement
5656

5757
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at [email protected]. All
58+
reported by contacting the project team at <[email protected]>. All
5959
complaints will be reviewed and investigated and will result in a response that
6060
is deemed necessary and appropriate to the circumstances. The project team is
6161
obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -71,4 +71,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
7171
available at [http://contributor-covenant.org/version/1/4][version]
7272

7373
[homepage]: http://contributor-covenant.org
74-
[version]: http://contributor-covenant.org/version/1/4/
74+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Contributing
1+
# Contributing
22

33
[fork]: https://github.com/advanced-security/spdx-to-dependency-graph-action/fork
44
[pr]: https://github.com/github/spdx-to-dependency-graph-action/compare
@@ -29,4 +29,4 @@ Here are a few things you can do that will increase the likelihood of your pull
2929

3030
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
3131
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
32-
- [GitHub Help](https://help.github.com)
32+
- [GitHub Help](https://help.github.com)

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# SPDX to Dependency Graph Action
22

3-
This repository makes it easy to upload an SPDX 2.2 formatted SBOM to GitHub's dependency submission API. This lets you quickly receive Dependabot alerts for package manifests which GitHub doesn't directly support like pnpm or Paket by using existing off-the-shelf SBOM generators.
3+
This repository makes it easy to upload an SPDX 2.2 formatted SBOM to GitHub's dependency submission API.
4+
This lets you quickly receive Dependabot alerts for package manifests which GitHub doesn't directly support like pnpm or Paket by using existing off-the-shelf SBOM generators.
45

5-
### Example workflow
6-
This workflow uses the [Microsoft sbom-tool](https://github.com/microsoft/sbom-tool).
7-
```yaml
6+
## Example workflow
7+
8+
This workflow uses the [Microsoft sbom-tool](https://github.com/microsoft/sbom-tool).
89

10+
```yaml
911
name: SBOM upload
1012

1113
on:
@@ -33,10 +35,23 @@ jobs:
3335
name: sbom
3436
path: _manifest/spdx_2.2
3537
- name: SBOM upload
36-
uses: advanced-security/spdx-dependency-submission-action@v0.0.1
38+
uses: advanced-security/spdx-dependency-submission-action@v0.1.0
3739
with:
3840
filePath: "_manifest/spdx_2.2/"
39-
```
41+
```
42+
43+
## Support
44+
45+
Please create [GitHub Issues][github-issues] if there are bugs or feature requests.
46+
47+
This project uses [Sematic Versioning (v2)](https://semver.org/) and with major releases, breaking changes will occur.
48+
49+
## License
50+
51+
This project is licensed under the terms of the MIT open source license.
52+
Please refer to [MIT][license] for the full terms.
53+
54+
<!-- Resources -->
4055
41-
# License
42-
This project is licensed under the terms of the MIT open source license. Please refere to MIT for the full terms.
56+
[license]: ./LICENSE
57+
[github-issues]: https://github.com/advanced-security/spdx-dependency-submission-action/issues

SECURITY.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
Thanks for helping make GitHub safe for everyone.
2-
31
# Security
42

3+
Thanks for helping make GitHub safe for everyone.
4+
55
GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as [GitHub](https://github.com/GitHub).
66

7-
Even though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation.
7+
Even though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation.
88

99
## Reporting Security Issues
1010

@@ -16,16 +16,16 @@ Instead, please send an email to opensource-security[@]github.com.
1616

1717
Please include as much of the information listed below as you can to help us better understand and resolve the issue:
1818

19-
* The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
20-
* Full paths of source file(s) related to the manifestation of the issue
21-
* The location of the affected source code (tag/branch/commit or direct URL)
22-
* Any special configuration required to reproduce the issue
23-
* Step-by-step instructions to reproduce the issue
24-
* Proof-of-concept or exploit code (if possible)
25-
* Impact of the issue, including how an attacker might exploit the issue
19+
* The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
20+
* Full paths of source file(s) related to the manifestation of the issue
21+
* The location of the affected source code (tag/branch/commit or direct URL)
22+
* Any special configuration required to reproduce the issue
23+
* Step-by-step instructions to reproduce the issue
24+
* Proof-of-concept or exploit code (if possible)
25+
* Impact of the issue, including how an attacker might exploit the issue
2626

2727
This information will help us triage your report more quickly.
2828

2929
## Policy
3030

31-
See [GitHub's Safe Harbor Policy](https://docs.github.com/en/github/site-policy/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)
31+
See [GitHub's Safe Harbor Policy](https://docs.github.com/en/github/site-policy/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)

SUPPORT.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11

2-
# Support
2+
# Support
33

44
## How to file issues and get help
55

66
This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue.
77

8-
For help or questions about using this project, please use GitHub discussions.
8+
For help or questions about using this project, please use GitHub discussions.
99

10-
- `SPDX to dependency graph action` is not actively developed but is maintained by GitHub staff. We will do our best to respond to support and community questions in a timely manner.
10+
- `SPDX to dependency graph action` is not actively developed but is maintained by GitHub staff. We will do our best to respond to support and community questions in a timely manner.
1111

1212
## GitHub Support Policy
1313

14-
Support for this project is limited to the resources listed above.
14+
Support for this project is limited to the resources listed above.

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ inputs:
1414
required: false
1515
default: '*.spdx.json'
1616
runs:
17-
using: 'node16'
17+
using: 'node20'
1818
main: 'dist/index.js'
1919
branding:
2020
icon: 'upload-cloud'

0 commit comments

Comments
 (0)