Skip to content

Commit ace2349

Browse files
committed
docs: add requirements section and update licensing link in README.
1 parent e7d7c65 commit ace2349

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@
44

55
This repository contains a suite of **Composite GitHub Actions** designed to automate semantic version bumping for various project types (Python, Maven, NPM, etc.) within Pull Requests.
66

7+
## Requirements
8+
9+
This project relies on the following software and tools:
10+
11+
* **[GitHub Actions Runner](https://github.com/actions/runner)**: Linux, macOS, or Windows runner.
12+
* **[Git](https://git-scm.com/)**: Version control system.
13+
* **[Node.js](https://nodejs.org/)**: Version 20 or higher (required for the action runtime).
14+
15+
Depending on your project type, you will also need:
16+
17+
* **[Maven](https://maven.apache.org/)**: For Maven projects (requires `mvn` in the PATH).
18+
* **[NPM](https://www.npmjs.com/)**: For Node.js projects (requires `npm` in the PATH).
19+
* **[Python](https://www.python.org/) & [Poetry](https://python-poetry.org/)**: For Python projects (requires `poetry` in the PATH).
20+
721
## GitHub Marketplace Usage
822

923
You can use this action directly from the GitHub Marketplace. It supports multiple project types via the `type` input.
@@ -101,4 +115,4 @@ We as members, contributors, and leaders pledge to make participation in our com
101115

102116
## Licensing
103117

104-
Copyright (20xx-)20xx SAP SE or an SAP affiliate company and <your-project> contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/<your-project>).
118+
Copyright (2025)2025 SAP SE or an SAP affiliate company and pull-request-semver-bumper contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/pull-request-semver-bumper).

0 commit comments

Comments
 (0)