Skip to content

Commit

Permalink
Remove files only applicable to main branch
Browse files Browse the repository at this point in the history
* Stable branch does not have a website, build, or changes file
* Provide a simplified README
  • Loading branch information
jodastephen committed Oct 4, 2024
1 parent 65f13d7 commit 5f1ee59
Show file tree
Hide file tree
Showing 15 changed files with 6 additions and 1,107 deletions.
5 changes: 0 additions & 5 deletions .github/FUNDING.yml

This file was deleted.

10 changes: 0 additions & 10 deletions .github/SECURITY.md

This file was deleted.

10 changes: 0 additions & 10 deletions .github/dependabot.yml

This file was deleted.

13 changes: 0 additions & 13 deletions .github/maven-settings.xml

This file was deleted.

25 changes: 1 addition & 24 deletions .github/website.sh
Original file line number Diff line number Diff line change
@@ -1,24 +1 @@

echo "## setup..."
git config --global user.name "Stephen Colebourne (CI)"
git config --global user.email "scolebourne@joda.org"
cd target

echo "## clone..."
git clone https://${GITHUB_TOKEN}@github.com/JodaOrg/jodaorg.github.io.git
cd jodaorg.github.io
git status

echo "## copy..."
rm -rf joda-convert/
cp -R ../site joda-convert/

echo "## update..."
git add -A
git status
git commit --message "Update joda-convert from CI: $GITHUB_ACTION"

echo "## push..."
git push origin main

echo "## done"
echo "## do nothing on v2.x"
10 changes: 1 addition & 9 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,7 @@ jobs:

- name: Maven build
run: |
mvn install site
mvn install
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3

- name: Website
if: github.event_name == 'push' && (startsWith(github.ref, 'refs/tags/website') || startsWith(github.ref, 'refs/tags/v'))
env:
GITHUB_TOKEN: ${{ secrets.PERSONAL_TOKEN_GH }}
run: |
chmod +x ./.github/website.sh
.github/website.sh
94 changes: 4 additions & 90 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,95 +1,9 @@
Joda-Convert
------------

Joda-Convert is a small, highly-focussed [library](https://www.joda.org/joda-convert/apidocs/org.joda.convert/org/joda/convert/StringConvert.html), tackling a problem that the JDK should solve -
providing round-trip conversion between Objects and Strings.
It is not intended to tackle the wider problem of Object to Object transformation.
Joda-Convert is a small, highly-focussed library providing round-trip conversion between Objects and Strings.

```java
// conversion to String
String str = StringConvert.INSTANCE.convertToString(foo);
This v2.x branch is considered stable and is based on Java 1.6.
Only backports are applied to this branch.

// conversion from String
Foo bar = StringConvert.INSTANCE.convertFromString(Foo.class, str);
```

Joda-Convert supports two mechanisms of extending the list of supported conversions.
The first is to write your own [converter](https://www.joda.org/joda-convert/apidocs/org.joda.convert/org/joda/convert/TypedStringConverter.html) implementing an interface.
The second is to use annotations.

The ability of Joda-Convert to use annotations to define the conversion methods is a key difference from other projects.
For example, most value classes, like `Currency` or `TimeZone`, already have methods
to convert to and from a standard format String.
Consider a `Distance` class annotated with
[`FromString`](https://www.joda.org/joda-convert/apidocs/org.joda.convert/org/joda/convert/FromString.html) and
[`ToString`](https://www.joda.org/joda-convert/apidocs/org.joda.convert/org/joda/convert/ToString.html):

```java
public class Distance {

@FromString
public static Distance parse(String str) { ... }

@ToString
public String getStandardOutput() { ... }

}
```

As shown, the two methods may have any name. They must simply fulfil the required method signatures for conversion.
The `FromString` annotation may also be applied to a constructor.

When Joda-Convert is asked to convert between an object and a String, if there is no registered converter
then the annotations are checked. If they are found, then the methods are called by reflection.

Joda-Convert is licensed under the business-friendly [Apache 2.0 licence](https://www.joda.org/joda-convert/licenses.html).


### Documentation
Various documentation is available:

* The [home page](https://www.joda.org/joda-convert/)
* The helpful [user guide](https://www.joda.org/joda-convert/userguide.html)
* The [Javadoc](https://www.joda.org/joda-convert/apidocs/index.html)
* The change notes for the [releases](https://www.joda.org/joda-convert/changes-report.html)


### Releases
[Release 2.2.3](https://www.joda.org/joda-convert/download.html) is the current latest release.
This release is considered stable and worthy of the 2.x tag.
The v2.x releases are compatible with v1.x releases, with the exception that the direct Guava dependency is removed.
It depends on Java SE 6 or later.

Available in the [Maven Central repository](https://search.maven.org/search?q=g:org.joda%20AND%20a:joda-convert&core=gav)

![Tidelift dependency check](https://tidelift.com/badges/github/JodaOrg/joda-convert)


### For enterprise
Available as part of the Tidelift Subscription.

Joda and the maintainers of thousands of other packages are working with Tidelift to deliver one enterprise subscription that covers all of the open source you use.

If you want the flexibility of open source and the confidence of commercial-grade software, this is for you.

[Learn more](https://tidelift.com/subscription/pkg/maven-org-joda-joda-convert?utm_source=maven-org-joda-joda-convert&utm_medium=github)


### Support
Please use [Stack Overflow](https://stackoverflow.com/search?q=joda-convert) for general usage questions.
GitHub [issues](https://github.com/JodaOrg/joda-convert/issues) and [pull requests](https://github.com/JodaOrg/joda-convert/pulls)
should be used when you want to help advance the project.

Any donations to support the project are accepted via [OpenCollective](https://opencollective.com/joda).

To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
Tidelift will coordinate the fix and disclosure.


### Release process

* Update version (README.md, index.md, changes.xml)
* Commit and push
* `mvn clean release:clean release:prepare release:perform`
* `git fetch`
* Website will be built and released by GitHub Actions
See the main [home page](https://www.joda.org/joda-convert/) for more info, including the latest supported branch.
72 changes: 0 additions & 72 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -472,33 +472,10 @@
<artifactId>spotbugs-maven-plugin</artifactId>
<version>${spotbugs-maven-plugin.version}</version>
</plugin>
<!-- Setup site with reflow maven skin -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>${maven-site-plugin.version}</version>
<configuration>
<skipDeploy>true</skipDeploy>
</configuration>
<executions>
<execution>
<id>attach-descriptor</id>
<goals>
<goal>attach-descriptor</goal>
</goals>
<!-- https://issues.apache.org/jira/browse/MSITE-639 -->
<configuration>
<locales>en,de</locales>
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.joda.external</groupId>
<artifactId>reflow-velocity-tools</artifactId>
<version>1.2</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</pluginManagement>
Expand Down Expand Up @@ -529,26 +506,6 @@
<!-- ==================================================================== -->
<reporting>
<plugins>
<!-- Setup standard project info reports -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>${maven-project-info-reports-plugin.version}</version>
<reportSets>
<reportSet>
<reports>
<report>ci-management</report>
<report>dependencies</report>
<report>dependency-info</report>
<report>issue-management</report>
<report>licenses</report>
<report>team</report>
<report>scm</report>
<report>summary</report>
</reports>
</reportSet>
</reportSets>
</plugin>
<!-- Setup Checkstyle report, excluding module-info -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
Expand All @@ -561,22 +518,6 @@
<excludes>module-info.java</excludes>
</configuration>
</plugin>
<!-- Setup Javadoc report -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
<reportSets>
<reportSet>
<reports>
<report>javadoc</report>
</reports>
</reportSet>
</reportSets>
<configuration>
<source>11</source>
</configuration>
</plugin>
<!-- Setup Surefire report -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
Expand All @@ -586,19 +527,6 @@
<showSuccess>true</showSuccess>
</configuration>
</plugin>
<!-- Setup changes (release notes) -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-changes-plugin</artifactId>
<version>${maven-changes-plugin.version}</version>
<reportSets>
<reportSet>
<reports>
<report>changes-report</report>
</reports>
</reportSet>
</reportSets>
</plugin>
<!-- Setup PMD report, excluding module-info -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
Expand Down
Loading

0 comments on commit 5f1ee59

Please sign in to comment.