Skip to content

Commit

Permalink
setting up imported repo:
Browse files Browse the repository at this point in the history
- setup CI and publish artifacts jobs (github actions)
- update some dependencies
- change published package namespace
- javadoc fixes
- update README.md
  • Loading branch information
Felipe Barriga Richards committed Apr 14, 2024
1 parent 4f8d5bd commit ad25c33
Show file tree
Hide file tree
Showing 31 changed files with 325 additions and 271 deletions.
27 changes: 0 additions & 27 deletions .github/workflows/build.yml

This file was deleted.

53 changes: 53 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: CI

on:
push:
branches:
- main
pull_request:
branches:
- '*'

permissions:
contents: read # to fetch code (actions/checkout)

jobs:
build-and-verify:
name: Build and verify (JDK ${{ matrix.java }})
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
java: ['8', '11', '17', '18']
steps:
- uses: actions/checkout@v4
- name: Set up JDK
uses: actions/setup-java@v4
with:
java-version: ${{ matrix.java }}
distribution: temurin
cache: maven
- name: Build and verify
run: mvn verify javadoc:javadoc --batch-mode --errors

# publish-snapshots:
# name: Publish snapshot artifacts
#
# permissions:
# contents: read
# packages: write
#
# if: github.event_name == 'push' && github.repository == 'fbarriga/jVT220' && github.ref == 'refs/heads/master'
# needs: build-and-verify
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v4
# - name: Set up JDK
# uses: actions/setup-java@v4
# with:
# java-version: '11'
# distribution: temurin
# - name: Publish snapshot artifacts
# run: mvn deploy --batch-mode --errors --activate-profiles release
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
70 changes: 70 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: Publish package to the Maven Central Repository and GitHub Packages

on:
release:
types: [created]

jobs:
publish:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- uses: actions/checkout@v4

########################################################################################################
# build and sign
- name: Set up Java for building and signing
uses: actions/setup-java@v4
with:
java-version: '11'
distribution: 'temurin'
overwrite-settings: true
gpg-passphrase: MAVEN_GPG_PASSPHRASE

- name: Configure GPG Key
run: |
echo -n "$GPG_SIGNING_KEY" | base64 --decode | gpg --import --pinentry-mode loopback --no-tty --batch --yes
env:
GPG_SIGNING_KEY: ${{ secrets.GPG_SIGNING_KEY }}

- name: Build and Sign
run: mvn --batch-mode verify --activate-profiles release,sign
env:
MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_SIGNING_KEY_PASSPHRASE }}

########################################################################################################
# publishing to maven central
- name: Set up Java for publishing to Maven Central Repository
uses: actions/setup-java@v4
with:
java-version: '11'
distribution: 'temurin'
overwrite-settings: true
server-id: maven
server-username: MAVEN_USERNAME
server-password: MAVEN_PASSWORD
gpg-passphrase: MAVEN_GPG_PASSPHRASE

- name: Publish to the Maven Central Repository
run: mvn --batch-mode deploy --activate-profiles release,sign,publish
env:
MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_SIGNING_KEY_PASSPHRASE }}

########################################################################################################
# publishing to github packages
- name: Set up Java for publishing to GitHub Packages
uses: actions/setup-java@v4
with:
java-version: '11'
distribution: 'temurin'
overwrite-settings: true
server-id: github

- name: Publish to GitHub Packages
run: mvn --batch-mode deploy --activate-profiles release,sign
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,37 @@
[![CI Status](https://github.com/fbarriga/jVT220/workflows/CI/badge.svg)](https://github.com/fbarriga/jVT220/actions)

# jVT220 - Java VT220 terminal emulator

This repository is forked from [jvt220](https://github.com/jawi/jVT220).
One of the most important changes in this forked version, is the addition of a [TerminalClient](/src/main/java/nl/lxtreme/jvt220/terminal/TerminalClient.java) class, which allows to actually connect to a VT-type mainframe application, and then using this well modularized project to parse the received information from [TelnetClient](https://commons.apache.org/proper/commons-net/) socket.
This repository is forked from [stephanemartin/jVT220](https://github.com/stephanemartin/jVT220) that was forked from [jvt220](https://github.com/jawi/jVT220).

For more information about the original project please visit the documentation [here](https://github.com/jawi/jVT220/blob/master/README.md)
For more information:
- Previous fork
- [https://github.com/stephanemartin/jVT220](https://github.com/stephanemartin/jVT220)
- Original repo
- [https://github.com/jawi/jVT220](https://github.com/jawi/jVT220)

## Usage

To use the emulator as Maven dependency include in `pom.xml`:
To use the emulator as Maven dependency include in `pom.xml`

```xml
<dependency>
<groupId>com.github.stephanemartin</groupId>
<artifactId>jVT220</artifactId>
<version>jvt220-v1.3.3-SNAPSHOT</version>
<groupId>cl.felipebarriga</groupId>
<artifactId>jvt220</artifactId>
<version>1.3.3</version>
</dependency>
```

>Check latest version in[releases](https://github.com/stephanemartin/jVT220/releases).
## Author

It is originally written by J.W. Janssen, <[email protected]>.

This version is currently maintained by tricentis.
Was later maintained by Stephane Martin (tricentis).

This repo is currently maintained by Felipe Barriga Richards.

## License

The code in this library is licensed under Apache Software License, version
2.0 and can be found online at: <http://www.apache.org/licenses/LICENSE-2.0>.
2.0 and can be found online at: <https://www.apache.org/licenses/LICENSE-2.0>.

Loading

0 comments on commit ad25c33

Please sign in to comment.