Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Bug report
description: Report a reproducible problem with Node Scraper
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug. Please include enough detail to reproduce the issue.
- type: textarea
id: summary
attributes:
label: Summary
description: What happened and what did you expect to happen?
placeholder: Clear and concise description of the bug.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Minimal, concrete steps to reproduce the issue.
placeholder: |
1. ...
2. ...
3. ...
validations:
required: true
- type: textarea
id: logs
attributes:
label: CLI output / logs
description: Paste relevant output (redact secrets/tokens/hosts as needed).
render: shell
validations:
required: false
- type: input
id: version
attributes:
label: Version
description: Output of `node-scraper --version` (or the git commit hash).
placeholder: "e.g. 0.6.1"
validations:
required: false
- type: dropdown
id: install_method
attributes:
label: Install method
options:
- PyPI (pip install amd-node-scraper)
- Editable install from source (pip install -e .)
- Other
validations:
required: false
- type: input
id: python
attributes:
label: Python version
placeholder: "e.g. 3.11.8"
validations:
required: false
- type: textarea
id: environment
attributes:
label: Environment
description: OS, target system type (LOCAL/REMOTE), and anything else relevant.
placeholder: |
OS:
Target:
Notes:
validations:
required: false
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Questions
url: https://github.com/amd/node-scraper/issues
about: If you're not sure it's a bug/feature request yet, start with an issue and add details.
- name: Security reports
url: https://github.com/amd/node-scraper/security/policy
about: Please report security issues privately (see SECURITY.md).
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Feature request
description: Suggest an enhancement or new capability
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for the suggestion. Please describe the problem you're trying to solve and what success looks like.
- type: textarea
id: problem
attributes:
label: Problem / motivation
description: What problem are you trying to solve?
placeholder: "I want to..."
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed solution
description: What would you like Node Scraper to do?
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: What else have you tried or considered?
validations:
required: false
- type: textarea
id: scope
attributes:
label: Scope / impact
description: What plugins/OSes/environments would this affect?
validations:
required: false
12 changes: 12 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Summary
-

## Test plan
- [ ] `pytest test/unit`
- [ ] `pytest test/functional` (if applicable)
- [ ] `pre-commit run --all-files`

## Checklist
- [ ] Added/updated tests (or explained why not)
- [ ] Updated docs/README if behavior changed
- [ ] No secrets or credentials committed
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ system debug.

## Table of Contents
- [Installation](#installation)
- [Install from PyPI](#install-from-pypi)
- [Install From Source](#install-from-source)
- [CLI Usage](#cli-usage)
- [Execution Methods](#execution-methods)
Expand All @@ -24,6 +25,19 @@ system debug.
invoked by collectors** -> See [docs/PLUGIN_DOC.md](docs/PLUGIN_DOC.md)

## Installation
### Install from PyPI
Node Scraper is published on [PyPI](https://pypi.org/project/amd-node-scraper/) as **amd-node-scraper**. Install it with Python 3.9 or newer:

```sh
pip install amd-node-scraper
```

Use a virtual environment if you prefer. After installation, confirm the CLI is available:

```sh
node-scraper --help
```

### Install From Source
Node Scraper requires Python 3.9+ for installation. After cloning this repository,
call dev-setup.sh script with 'source'. This script creates an editable install of Node Scraper in
Expand Down
34 changes: 34 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Security Policy

## Supported Versions

We provide security updates for the **latest released version** and for the **default branch**.

| Version | Supported |
| ------- | ------------------ |
| Default branch (`main` / `development`) | :white_check_mark: |
| Latest PyPI release (`amd-node-scraper`) | :white_check_mark: |
| Older releases | :x: |

## Reporting a Vulnerability

Please **do not** open a public issue for security vulnerabilities.

### Preferred: private vulnerability report (GitHub)

If enabled for this repository, use GitHub’s private vulnerability reporting:

- `https://github.com/amd/node-scraper/security/advisories/new`

### What to include

- A clear description of the issue and potential impact
- Steps to reproduce (or a proof-of-concept, if safe to share)
- The output of `node-scraper --version` (or a git commit hash)
- Any relevant configuration details (please redact secrets/credentials/hostnames/IPs)

### What to expect

- We will acknowledge receipt as soon as practical.
- If the report is accepted, we’ll work on a fix and coordinate disclosure timing.
- If the report is declined (e.g., not a security issue), we’ll explain why.
Loading