Skip to content
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.

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

[pull] main from anchore:main #1

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
95b086a
fix: workaround windows install script (#477)
willmurphyscode Jul 9, 2024
f3253ca
chore(deps): update Syft to v1.8.0 (#473)
anchore-actions-token-generator[bot] Jul 10, 2024
f4035cd
chore: serialize tests to prevent install race (#478)
willmurphyscode Jul 10, 2024
23e0b38
chore(deps): bump peter-evans/create-pull-request from 6.0.5 to 6.1.0…
dependabot[bot] Jul 10, 2024
ee41e6a
chore(deps): bump actions/checkout from 4.1.6 to 4.1.7 (#474)
dependabot[bot] Jul 10, 2024
d94f46e
chore(deps): update Syft to v1.9.0 (#479)
anchore-actions-token-generator[bot] Jul 11, 2024
ca15f99
docs: CODE_OF_CONDUCT.md (#480)
popey Jul 18, 2024
f2d02cb
chore: Create issue template (#481)
popey Jul 18, 2024
fe5e7c3
doc: Updates for the Slack to Discourse migration (#484)
popey Aug 12, 2024
ab9d16d
chore(deps): update Syft to v1.11.0 (#483)
anchore-actions-token-generator[bot] Aug 13, 2024
61119d4
chore(deps): update Syft to v1.11.1 (#485)
anchore-actions-token-generator[bot] Aug 21, 2024
9249ac2
chore(deps): bump micromatch from 4.0.4 to 4.0.8 (#491)
dependabot[bot] Sep 17, 2024
8abbe51
chore(deps): bump path-to-regexp from 6.2.2 to 6.3.0 (#492)
dependabot[bot] Sep 17, 2024
dbef896
add awaiting response management (#494)
wagoodman Sep 25, 2024
5cc1a40
chore(deps): bump actions/checkout from 4.1.7 to 4.2.0 (#495)
dependabot[bot] Oct 5, 2024
87b3137
chore(deps): update Syft to v1.13.0 (#488)
anchore-actions-token-generator[bot] Oct 5, 2024
beb779b
Update README to include bit about permissions near the top (#496)
joshbuker Oct 5, 2024
8cb9966
chore(deps): update Syft to v1.14.0 (#498)
anchore-actions-token-generator[bot] Oct 8, 2024
4a914bc
chore(deps): bump actions/checkout from 4.2.0 to 4.2.1 (#497)
dependabot[bot] Oct 9, 2024
2e87236
add release docs (#500)
wagoodman Oct 11, 2024
18f9bde
chore: remove snapshot tests; fix deprecation errors for outdated pac…
spiffcs Oct 11, 2024
eff08d0
chore: configure changelog-ignore label (#499)
willmurphyscode Oct 11, 2024
f5e124a
chore(deps): bump peter-evans/create-pull-request from 6.1.0 to 7.0.5…
dependabot[bot] Oct 11, 2024
8d0a650
chore(deps): update Syft to v1.14.1 (#502)
anchore-actions-token-generator[bot] Oct 15, 2024
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
84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
name: Bug report
description: Create a bug report
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: checkboxes
attributes:
label: Are you using the latest sbom-action version available?
description: |
Ensure that you're using the latest sbom-action version.
https://github.com/anchore/sbom-action/releases/latest
options:
- label: I am using the latest sbom-action version.
required: true
- label: |
I can reproduce the issue running sbom-action using complete version identifier (example: vX.Y.Z), and not just with a partial one (example: vX)
required: true
- label: |
I am using the anchore/sbom-action action.
required: true
- type: checkboxes
attributes:
label: Are you resonably sure that it's a sbom-action issue, and not an issue related to a tool that sbom-action runs?
description: |
If you encounter a specific issue, ensure that the issue is about
sbom-action, and not about a tool that sbom-action runs. For example,
if the action reports an unexpected or a surprising error, you may check
if there are similar issues reported in that components's issue tracker.
options:
- label: I think that this is a sbom-action issue.
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: sbom-action version
description: |
sbom-action version where you observed this issue
placeholder: |
vX.Y.Z
render: markdown
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Copy and paste any relevant log output.
This will be automatically formatted into code, so no need for backticks.
Enable debug logging, either on GitHub Actions, or when running locally.
Not attaching debug logging will delay the issue triaging process.
render: shell
validations:
required: true
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
validations:
required: false
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

**What would you like to be added**:

**Why is this needed**:

**Additional context**:
<!-- Add any other context or screenshots about the feature request here. -->
3 changes: 3 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ version-resolver:
labels: [patch]
default: patch

exclude-labels:
- "changelog-ignore"

template: |
## Changes in v$RESOLVED_VERSION
Expand Down
11 changes: 11 additions & 0 deletions .github/workflows/remove-awaiting-response-label.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: "Manage Awaiting Response Label"

on:
issue_comment:
types: [created]

jobs:
run:
uses: "anchore/workflows/.github/workflows/remove-awaiting-response-label.yaml@main"
secrets:
token: ${{ secrets.OSS_PROJECT_GH_TOKEN }}
8 changes: 4 additions & 4 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
build: # make sure build/ci work properly and there is no faked build ncc built scripts
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
- run: npm ci
- run: npm run package
- run: git status --porcelain
Expand All @@ -30,7 +30,7 @@ jobs:
os: [ubuntu-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
with:
path: ./
artifact-name: ${{ matrix.os }}-1.spdx
Expand Down Expand Up @@ -64,7 +64,7 @@ jobs:
ports:
- 5000:5000
steps:
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
- name: Build images
run: |
for distro in alpine centos debian; do
Expand All @@ -77,7 +77,7 @@ jobs:
test-as-action: # make sure the action works on a clean machine without building
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
with:
path: ./

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/update-syft-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
if: github.repository == 'anchore/sbom-action'
steps:
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
- name: Get latest Syft version
id: latest-version
env:
Expand All @@ -29,7 +29,7 @@ jobs:
with:
app_id: ${{ secrets.TOKEN_APP_ID }}
private_key: ${{ secrets.TOKEN_APP_PRIVATE_KEY }}
- uses: peter-evans/create-pull-request@6d6857d36972b65feb161a90e484f2984215f83e # v6.0.5
- uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f # v7.0.5
with:
signoff: true
delete-branch: true
Expand Down
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[opensource@anchore.com](mailto:opensource@anchore.com).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# GitHub Action for SBOM Generation

**A GitHub Action for creating a software bill of materials (SBOM) using [Syft](https://github.com/anchore/syft).**

[![GitHub release](https://img.shields.io/github/release/anchore/sbom-action.svg)](https://github.com/anchore/sbom-action/releases/latest)
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/anchore/sbom-action/blob/main/LICENSE)
[![Slack Invite](https://img.shields.io/badge/Slack-Join-blue?logo=slack)](https://anchore.com/slack)

A GitHub Action for creating a software bill of materials (SBOM)
using [Syft](https://github.com/anchore/syft).
[![Join our Discourse](https://img.shields.io/badge/Discourse-Join-blue?logo=discourse)](https://anchore.com/discourse)

## Basic Usage

Expand All @@ -18,6 +17,17 @@ and upload a workflow artifact SBOM in SPDX format. It will also detect
if being run during a [GitHub release](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases)
and upload the SBOM as a release asset.

> [!IMPORTANT]
> To upload the SBOM to releases, you will need to give the action permission to read the artifact from the action, and write it to the release:
> ```yaml
> jobs:
> build:
> permissions:
> actions: read
> contents: write
> steps:
> ```

## Example Usage

### Scan a container image
Expand Down
19 changes: 19 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Release

A release of sbom-action comprises:
- a new semver git tag from the current tip of the main branch
- a new [github release](https://github.com/anchore/sbom-action/releases) with a changelog
- the action distributable committed into the repo at `dist/`

Ideally releasing should be done often with small increments when possible. Unless a
breaking change is blocking the release, or no fixes/features have been merged, a good
target release cadence is between every 1 or 2 weeks.


## Creating a release

Releases are automatically drafted on every push to the main branch. Please see the [github releases page](https://github.com/anchore/sbom-action/releases) for the latest draft. To publish the release:

- Click "edit" (the pencil icon)
- Modify the changelog as needed (for instance, if syft was bumped multiple times, include only the latest version bump entry)
- Click "publish"
Loading