Skip to content

Commit

Permalink
ci: trigger release build
Browse files Browse the repository at this point in the history
  • Loading branch information
@sebthom
sebthom committed Oct 10, 2024
1 parent 8e624d4 commit d13174a
Show file tree
Hide file tree
Showing 6 changed files with 211 additions and 45 deletions.
4 changes: 2 additions & 2 deletions .ci/release-trigger.sh
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# this file is evaluated by .ci/build.sh

POM_CURRENT_VERSION="7.13.1-SNAPSHOT" # perform release if pom.xml matches this version
POM_RELEASE_VERSION="7.14.0" # next release version
POM_CURRENT_VERSION="8.0.0-SNAPSHOT" # perform release if pom.xml matches this version
POM_RELEASE_VERSION="8.0.0" # next release version

DRY_RUN=false # is dry run?
SKIP_TESTS=true # skip tests during release build?
1 change: 1 addition & 0 deletions .github/workflows/build.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ jobs:
- name: "Build with Maven 🔨"
if: ${{ matrix.may_create_release && !env.ACT }}
id: maven-build
env:
DEPLOY_SNAPSHOTS_TO_GITHUB_BRANCH: true
GITHUB_USER: ${{ github.actor }}
Expand Down
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# 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, caste, color, 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
https://github.com/orgs/sebthom/jstuff/issues
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.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
45 changes: 35 additions & 10 deletions CODING_GUIDELINES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,48 @@

### Acronyms in Names

1. For 4+ letter acronyms, use lowercase. E.g. `LdapUtils`, `HttpURL`
1. For **4+ letter acronyms**, use lowercase. E.g. `LdapUtils`, `HttpURL`.

1. For 2 and 3 letter acronyms, use uppercase. E.g. `IOUtils`, `XMLUtils`
1. For **2 and 3 letter acronyms**, use uppercase. E.g. `IOUtils`, `XMLUtils`.

### Interfaces and Implementing Classes

1. Do NOT prefix interfaces with `I`.
1. Do **NOT** prefix interfaces with `I`.
Interface names should represent their role in the system without any syntactic markers.
E.g. `UserService`, not `IUserService`.

1. Do NOT postfix implementations with `Impl`.
1. Do **NOT** postfix implementations with `Impl`.
Instead, focus on meaningful and descriptive names.
E.g. `LdapUserService`, not `UserServiceImpl`.

1. Use normal words for interfaces, e.g. `UserService`.
1. **Descriptive naming for multiple implementations**:
If there are multiple implementations of an interface, make sure each class name reflects its purpose or underlying mechanism, e.g. `LdapUserService`, `JdbcUserService`.

1. For implementations use the interface name with a meaningful prefix, e.g. `LdapUserService`.

1. If only one implementation exists and an interface is only necessary for technical requirements (e.g. remoting),
you can prefix the interface name with `Default` and use it as your implementation's class name, e.g. `DefaultUserService`
1. If only **one implementation** exists and the interface is required only for technical purposes (e.g., remoting),
**prefix the implementation** with `Default`, and use the same name for the interface and the class. E.g. `DefaultUserService`.

### Constants (static final)

Use uppercase letters and separate words with underlines, e.g. `MAX_LENGTH`
1. Use **UPPERCASE** letters and separate words with underscores, e.g. `MAX_LENGTH`, `DEFAULT_TIMEOUT`.


## Source Code Formatting

1. Format your code contributions using the [vegardit.com Eclipse formatter rules](https://github.com/vegardit/vegardit-maven-parent/blob/main/src/etc/eclipse-formatter.xml).

IntelliJ users can use the [Eclipse Code Formatter](https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter) plugin to import and use the formatter settings.

To format the source code on the command line use `mvn process-sources -Dformatter.skip=false`

1. **Consistent line length**: Maintain a maximum line length of **140** characters.

1. **Use spaces, not tabs**: Set the indentation to **3** spaces per level.

1. **Braces placement**: Use the **K&R** style (braces on the same line), e.g.:
```java
if (condition) {
// action
} else {
// action
}

40 changes: 26 additions & 14 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,33 +1,45 @@
# Contributing
# Contributing to the Project

Thanks for your interest in contributing to this project!
Thank you for your interest in contributing to this project! We strive to make the contribution process clear and welcoming.

We want to make contributing as easy and transparent as possible.
Please take a moment to review the guidelines below.


## Code of Conduct

Our code of conduct is described in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
Please follow it in all your interactions with the project.
Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) in all your interactions with the project.
This helps us maintain a positive and respectful environment for everyone involved.


## Issues
## How to Contribute

We use GitHub issues to track bugs and feature requests. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
### Contributor Responsibilities

By submitting your contributions, you agree to the following:
- You are the sole author of the content you contribute, or you have the appropriate rights and permissions to contribute it.
- If employed, you have obtained any necessary permissions from your employer to contribute to this project.
- All contributions will be made available under the project’s license.

## Pull Requests
### Issues

Before you make a substantial pull request, please file an issue and make sure someone from the team agrees that there is a problem or room for improvement.
We use GitHub Issues to track bugs and feature requests. When submitting an issue, please ensure:
- The description is clear and concise.
- You provide enough details and steps to reproduce the issue, if applicable.

### Pull Requests

### License
Before making substantial contributions:
1. **Discuss Changes**: Please file an issue first to discuss your proposed changes with the team. This helps ensure your contribution aligns with the project’s goals.
2. **Follow Best Practices**: Adhere to the guidelines and ensure your code meets the project’s standards (see [Code Guidelines](#code-guidelines)).

By contributing your code, you agree to license your contribution under the [Eclipse Public License 2.0](LICENSE.txt).
When submitting a pull request:
- Ensure your changes are well-documented.
- Include tests for any new features or significant changes.
- Reference the relevant issue(s) in your pull request description.


### Source Code Formatting
## Licensing

Before committing your code ensure it is formatted according the [vegardit.com Eclipse formatter rules](https://github.com/vegardit/vegardit-maven-parent/blob/main/src/etc/eclipse-formatter.xml).
By contributing to this project, you agree that your contributions will be licensed under the [Eclipse Public License 2.0](LICENSE.txt).

IntelliJ users can use the [Eclipse Code Formatter](https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter) plugin to import and use the formatter settings.
The project itself is also licensed under the [Eclipse Public License 2.0](LICENSE.txt)).
34 changes: 15 additions & 19 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,47 +1,43 @@
# jstuff - toolbox for Java

[![Build Status](https://github.com/sebthom/jstuff/workflows/Build/badge.svg "GitHub Actions")](https://github.com/sebthom/jstuff/actions/workflows/build.yml)
[![Javadoc](https://img.shields.io/badge/JavaDoc-Online-green)](https://sebthom.github.io/jstuff/javadoc/)
[![Build Status](https://img.shields.io/github/actions/workflow/status/sebthom/jstuff/build.yml?logo=github)](https://github.com/sebthom/jstuff/actions/workflows/build.yml)
[![Javadoc](https://img.shields.io/badge/javadoc-online-green)](https://sebthom.github.io/jstuff/javadoc/)
[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/sebthom/jstuff)](https://codeclimate.com/github/sebthom/jstuff/maintainability)
[![Test Coverage](https://img.shields.io/codeclimate/coverage/sebthom/jstuff)](https://codeclimate.com/github/sebthom/jstuff/test_coverage)
[![License](https://img.shields.io/github/license/sebthom/jstuff.svg?color=blue)](LICENSE.txt)
[![Maintainability](https://api.codeclimate.com/v1/badges/7559e7b3c129d5ecc4db/maintainability)](https://codeclimate.com/github/sebthom/jstuff/maintainability)
[![Maven Central](https://img.shields.io/maven-central/v/net.sf.jstuff/jstuff-parent)](https://central.sonatype.com/search?namespace=net.sf.jstuff)


## Table of Contents

1. [What is it?](#what-is-it)
1. [Java Compatibility](#compatibility)
1. [Binaries](#binaries)
1. [License](#license)
2. [Java Compatibility](#compatibility)
3. [Binaries](#binaries)
4. [License](#license)


## <a name="what-is-it"></a>What is it?

jstuff is a collection of utility libraries

1. [jstuff-core](/jstuff-core/src/main/java/net/sf/jstuff/core) - core utility classes for the Java SE standard library.

1. [jstuff-integration](/jstuff-integration/src/main/java/net/sf/jstuff/integration) - utility classes for Java EE (Servlet, JPA, ...) and 3rd party frameworks (Spring, Jackson).

1. [jstuff-xml](/jstuff-xml/src/main/java/net/sf/jstuff/xml) - contains supporting classes for XML processing.
2. [jstuff-integration](/jstuff-integration/src/main/java/net/sf/jstuff/integration) - utility classes for Java EE (Servlet, JPA, ...) and 3rd party frameworks (Spring, Jackson).
3. [jstuff-xml](/jstuff-xml/src/main/java/net/sf/jstuff/xml) - contains supporting classes for XML processing.


## <a name="compatibility"></a>Java Compatibility

jstuff 1.x-4.x requires Java 5 or newer.

jstuff 5.x requires Java 8 or newer.

jstuff 6.x-7.x requires Java 11 or newer.

jstuff 8.x requires Java 17 or newer.
- jstuff 8.x requires Java 17 or newer.
- jstuff 6.x-7.x requires Java 11 or newer.
- jstuff 5.x requires Java 8 or newer.
- jstuff 1.x-4.x requires Java 5 or newer.


## <a name="binaries"></a>Binaries

Releases of this project are available at https://search.maven.org/search?q=g:net.sf.jstuff
Latest **release** binaries are available on Maven Central, see https://central.sonatype.com/search?namespace=net.sf.jstuff

You can add the required jstuff module as a dependency to your `pom.xml`:
You can add the required jstuff module as a dependency in your `pom.xml`:

```xml
<project>
Expand Down

0 comments on commit d13174a

Please sign in to comment.