spring-projects/spring-batch
spring-projects/spring-batch
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-batch.git synced 2024-10-23 08:34:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update community files

Browse Source
This commit is contained in:
Mahmoud Ben Hassine 2023-03-23 13:24:02 +01:00
parent 71e7dd5a55
commit f06772db14
No known key found for this signature in database
GPG Key ID: 1E2DE50D3F9FB51D
4 changed files with 57 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.github/ISSUE_TEMPLATE/miscellaneous.md vendored
View File

@ -10,5 +10,8 @@ assignees: ''
For anything other than bug reports and feature requests (performance, refactoring, etc),
just go ahead and file the issue. Please provide as many details as possible.
If you have a question, please use [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch) and tag your question
with `spring-batch`. We would like to keep the issue tracker exclusively for bug reports and feature requests.
If you have a question or a support request, please open a new discussion on [GitHub Discussions](https://github.com/spring-projects/spring-batch/discussions)
or ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch).
Please do **not** create issues on the [Issue Tracker](https://github.com/spring-projects/spring-batch/issues) for questions or support requests.
We would like to keep the issue tracker **exclusively** for bug reports and feature requests.

7
CONTRIBUTING.md
View File

@ -17,19 +17,18 @@ Please see our [Security policy](https://github.com/spring-projects/spring-batch
## Reporting issues
Is there already an issue that addresses your concern? Please do a quick search in [Github issues][] to see if you can find something similar.
Before opening an issue, please do a quick search in [Github issues][] to see if you can find something similar.
If not, please read the [Issue Reporting](https://github.com/spring-projects/spring-batch/blob/main/ISSUE_REPORTING.md) section for more details
about how to report issues.
## Contributing through Pull Requests on GitHub
Not sure what a *pull request* is, or how to submit one? Take a look at the excellent [GitHub help documentation][] first.
Not sure what a *pull request* is, or how to submit one? Take a look at the excellent [GitHub help documentation][] first.
Please create a new issue *before* submitting a pull request unless the change is truly trivial, e.g. typo fixes, removing compiler warnings, etc.
### Sign the contributor license agreement
If you have not previously done so, please fill out and
submit the [Contributor License Agreement](https://cla.pivotal.io/sign/spring).
If you have not previously done so, please fill out and submit the [Contributor License Agreement](https://cla.pivotal.io/sign/spring).
### Fork the Repository

78
README.md
View File

@ -6,23 +6,47 @@ Spring Batch is a lightweight, comprehensive batch framework designed to enable
If you are looking for a runtime orchestration tool for your Batch applications, or need a management console to view current and historic executions, take a look at [Spring Cloud Data Flow](https://cloud.spring.io/spring-cloud-dataflow/). It is an orchestration tool for deploying and executing data integration based microservices including Spring Batch applications.
## Code of Conduct
# Getting Started
Please see our [code of conduct](https://github.com/spring-projects/.github/blob/main/CODE_OF_CONDUCT.md).
## Guide
## Reporting Security Vulnerabilities
This is the quickest way to get started with a new Spring Batch project based on Spring Boot. You find the Getting Started Guide here: [Creating a Batch Service](https://spring.io/guides/gs/batch-processing/).
## Samples
You can find several samples to try out here: [Spring Batch Samples](https://github.com/spring-projects/spring-batch/tree/main/spring-batch-samples).
# Getting Help
If you have a question or a support request, please open a new discussion on [GitHub Discussions](https://github.com/spring-projects/spring-batch/discussions)
or ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch).
Please do **not** create issues on the [Issue Tracker](https://github.com/spring-projects/spring-batch/issues) for questions or support requests.
We would like to keep the issue tracker **exclusively** for bug reports and feature requests.
# Reporting issues
Spring Batch uses [GitHub Issues](https://github.com/spring-projects/spring-batch/issues) to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:
* Before you open an issue, please search the issue tracker to see if someone has already reported the problem. If the issue doesn't already exist, create a new issue.
* Please provide as much information as possible in the issue report by following the [Issue Reporting Template](https://github.com/spring-projects/spring-batch/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
* If you need to paste code or include a stack trace, please use Markdown escapes (```) before and after your text.
For non trivial bugs, please create a test case or a project that replicates the problem and attach it to the issue, as detailed in the [Issue Reporting Guidelines](https://github.com/spring-projects/spring-batch/blob/main/ISSUE_REPORTING.md).
# Reporting Security Vulnerabilities
Please see our [Security policy](https://github.com/spring-projects/spring-batch/security/policy).
# Building from Source
## Using the Command Line
Clone the git repository using the URL on the Github home page:
$ git clone git@github.com:spring-projects/spring-batch.git
$ cd spring-batch
## Command Line
Maven is the build tool used for Spring Batch. You can build the project with the following command:
$ ./mvnw package
@ -43,9 +67,6 @@ $ ../mvnw site
The reference documentation can be found in `spring-batch-docs/target`.
## Spring Tool Suite (STS)
In STS (or any Eclipse distro or other IDE with Maven support), import the module directories as existing projects. They should compile and the tests should run with no additional steps.
## Using Docker
If you want to build the project in a Docker container, you can proceed as follows:
@ -67,33 +88,22 @@ $> docker run -it maven:3-openjdk-17 bash
#> ./mvnw package
```
# Getting Started Using Spring Boot
This is the quickest way to get started with a new Spring Batch project. You find the Getting Started Guide for Spring
Batch on Spring.io: [Creating a Batch Service](https://spring.io/guides/gs/batch-processing/)
# Getting Started Using Spring Tool Suite (STS)
It requires an internet connection for download, and access to a Maven repository (remote or local).
* Download STS version 3.4.* (or better) from the [Spring website](https://spring.io/tools). STS is a free Eclipse bundle with many features useful for Spring developers.
* Go to `File->New->Spring Template Project` from the menu bar (in the Spring perspective).
* The wizard has a drop down with a list of template projects. One of them is a "Simple Spring Batch Project". Select it and follow the wizard.
* A project is created with all dependencies and a simple input/output job configuration. It can be run using a unit test, or on the command line (see instructions in the pom.xml).
# Getting Help
Read the main project [website](https://projects.spring.io/spring-batch/) and the [User Guide](https://docs.spring.io/spring-batch/docs/current/reference/).
Look at the source code and the Javadocs.
For more detailed questions, use [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch).
If you are new to Spring as well as to Spring Batch, look for information about [Spring projects](https://spring.io/projects).
# Contributing to Spring Batch
Here are some ways for you to get involved in the community:
We welcome contributions in any kind! Here are some ways for you to contribute to the project:
* Get involved with the Spring Batch community on [Twitter](https://twitter.com/springbatch) and [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch) by responding to questions and joining the debate.
* Create [issues](https://github.com/spring-projects/spring-batch/issues) for bugs and new features and comment and vote on the ones that you are interested in.
* Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](https://help.github.com/forking/). If you want to contribute code this way, please familiarize yourself with the process outlined for contributing to Spring projects here: [Contributor Guidelines](https://github.com/spring-projects/spring-batch/blob/main/CONTRIBUTING.md).
* Watch for upcoming articles on Spring by [subscribing](feed://assets.spring.io/drupal/node/feed.xml) to [spring.io](https://spring.io).
* Get involved with the Spring Batch community on [Twitter](https://twitter.com/springbatch), [GitHub Discussions](https://github.com/spring-projects/spring-batch/discussions) and [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch) by responding to questions and joining the debate.
* Create [issues](https://github.com/spring-projects/spring-batch/issues) for bugs and new features or comment and vote on the ones that you are interested in.
* Help us reproduce issues marked with [status: need-help-to-reproduce](https://github.com/spring-projects/spring-batch/labels/status%3A%20need-help-to-reproduce) by following the [Issue Reporting Guidelines](https://github.com/spring-projects/spring-batch/blob/main/ISSUE_REPORTING.md).
* Github is for social coding: if you want to write code, we encourage contributions through pull requests. If you want to contribute code this way, please familiarize yourself with the process outlined here: [Contributor Guidelines](https://github.com/spring-projects/spring-batch/blob/main/CONTRIBUTING.md).
* Watch for Spring Batch related articles on [spring.io](https://spring.io).
Before we accept a non-trivial patch or pull request we will need you to sign the [contributor's agreement](https://support.springsource.com/spring_committer_signup). Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.
Before we accept pull requests, we will need you to sign the [contributor's agreement](https://support.springsource.com/spring_committer_signup). Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.
# Code of Conduct
Please see our [code of conduct](https://github.com/spring-projects/.github/blob/main/CODE_OF_CONDUCT.md).
# License
Spring Batch is Open Source software released under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html).

7
SUPPORT.md
View File

@ -1,2 +1,5 @@
If you have a question, please use [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch) and tag your question
with `spring-batch`. We would like to keep the issue tracker exclusively for bug reports and feature requests.
If you have a question or a support request, please open a new discussion on [GitHub Discussions](https://github.com/spring-projects/spring-batch/discussions)
or ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/spring-batch).
Please do **not** create issues on the [Issue Tracker](https://github.com/spring-projects/spring-batch/issues) for questions or support requests.
We would like to keep the issue tracker **exclusively** for bug reports and feature requests.