Skip to content

Commit 017de20

Browse files
committed
Updated project boilerplate
1 parent 61a677a commit 017de20

10 files changed

Lines changed: 256 additions & 564 deletions

File tree

.github/workflows/build.yml

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# Generated by scripts/configure.py
21
name: build
32
on:
43
push:
@@ -10,18 +9,18 @@ jobs:
109
build:
1110
runs-on: ubuntu-latest
1211
steps:
13-
- uses: actions/checkout@v2
14-
- uses: actions/setup-java@v2
12+
- uses: actions/checkout@v4
13+
- uses: actions/setup-java@v4
1514
with:
16-
distribution: temurin
17-
java-version: 11
18-
cache: maven
19-
- name: Maven
20-
run: |
21-
# GPG must be skipped, because CI server does not have release GPG key.
22-
# Failure on javadoc warnings is enabled only in CI builds,
23-
# so that warnings specific to one JDK version do not break independent builds.
24-
# Printing maven version (-V) helps diagnose CI-specific build behavior.
25-
# JaCoCo phase is needed to create code coverage report that will be later uploaded to Codecov.
26-
mvn install jacoco:report -Dgpg.skip=true -Dmaven.javadoc.failOnWarnings=true -B -V
27-
- uses: codecov/codecov-action@v2
15+
distribution: 'temurin'
16+
java-version: '11'
17+
cache: 'maven'
18+
- name: Build and test
19+
# -B runs in non-interactive (batch) mode
20+
# -V displays version information
21+
# jacoco:report generates test coverage report
22+
# -Dmaven.javadoc.failOnWarnings=true enforces Javadoc quality
23+
# -Dgpg.skip=true skips GPG signing, which is only done on release
24+
run: mvn -B -V install jacoco:report -Dmaven.javadoc.failOnWarnings=true -Dgpg.skip=true
25+
- name: Upload coverage to Codecov
26+
uses: codecov/codecov-action@v4

.github/workflows/release.yml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
1-
# Generated by scripts/configure.py
21
name: release
3-
on: workflow_dispatch
2+
on:
3+
workflow_dispatch:
44
jobs:
55
release:
66
runs-on: ubuntu-latest
77
steps:
8-
- uses: actions/checkout@v2
9-
- uses: actions/setup-java@v2
8+
- uses: actions/checkout@v4
9+
- uses: actions/setup-java@v4
1010
with:
11-
distribution: temurin
12-
java-version: 11
13-
server-id: ossrh
11+
distribution: 'temurin'
12+
java-version: '11'
13+
server-id: 'central'
1414
server-username: MAVEN_SERVER_USERNAME
1515
server-password: MAVEN_SERVER_PASSWORD
1616
gpg-private-key: ${{ secrets.MAVEN_SIGNING_KEY }}
1717
gpg-passphrase: MAVEN_SIGNING_PASSWORD
18-
cache: maven
19-
- name: Maven
20-
# Printing maven version (-V) helps diagnose GitHub-specific build behavior.
18+
cache: 'maven'
19+
- name: Publish to Maven Central
20+
# -B runs in non-interactive (batch) mode
21+
# -V displays version information
2122
run: mvn -B -V deploy
2223
env:
2324
MAVEN_SERVER_USERNAME: robertvazan

.gitignore

Lines changed: 16 additions & 272 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,19 @@
1-
# Generated by scripts/configure.py
2-
3-
# https://github.com/github/gitignore/blob/master/Java.gitignore
4-
# --------------------------------------------------------------
5-
6-
# Compiled class file
7-
*.class
8-
9-
# Log file
10-
*.log
11-
12-
# BlueJ files
13-
*.ctxt
14-
15-
# Mobile Tools for Java (J2ME)
16-
.mtj.tmp/
17-
18-
# Package Files #
19-
*.jar
20-
*.war
21-
*.nar
22-
*.ear
23-
*.zip
24-
*.tar.gz
25-
*.rar
26-
27-
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
28-
hs_err_pid*
1+
# Common operating system files
2+
*~
3+
.DS_Store
4+
Thumbs.db
5+
.directory
6+
.fuse_hidden*
7+
.nfs*
298

30-
# https://github.com/github/gitignore/blob/master/Maven.gitignore
31-
# ---------------------------------------------------------------
9+
# Common IDE/editor files
10+
.vscode/
11+
.idea/
3212

13+
# Maven build directory
3314
target/
15+
16+
# Maven-specific files
3417
pom.xml.tag
3518
pom.xml.releaseBackup
3619
pom.xml.versionsBackup
@@ -39,249 +22,10 @@ release.properties
3922
dependency-reduced-pom.xml
4023
buildNumber.properties
4124
.mvn/timing.properties
42-
# https://github.com/takari/maven-wrapper#usage-without-binary-jar
4325
.mvn/wrapper/maven-wrapper.jar
4426

45-
# https://github.com/github/gitignore/blob/master/Eclipse.gitignore (modified)
46-
# ----------------------------------------------------------------------------
47-
48-
.metadata
49-
bin/
50-
tmp/
51-
*.tmp
52-
*.bak
53-
*.swp
54-
*~.nib
55-
local.properties
56-
.settings/
57-
.loadpath
58-
.recommenders
59-
60-
# External tool builders
61-
.externalToolBuilders/
62-
63-
# Locally stored "Eclipse launch configurations"
64-
*.launch
65-
66-
# PyDev specific (Python IDE for Eclipse)
67-
*.pydevproject
68-
69-
# CDT-specific (C/C++ Development Tooling)
70-
.cproject
71-
72-
# CDT- autotools
73-
.autotools
74-
75-
# Java annotation processor (APT)
76-
.factorypath
77-
78-
# PDT-specific (PHP Development Tools)
79-
.buildpath
80-
81-
# sbteclipse plugin
82-
.target
83-
84-
# Tern plugin
85-
.tern-project
86-
87-
# TeXlipse plugin
88-
.texlipse
89-
90-
# STS (Spring Tool Suite)
91-
.springBeans
92-
93-
# Code Recommenders
94-
.recommenders/
95-
96-
# Annotation Processing
97-
.apt_generated/
98-
.apt_generated_test/
99-
100-
# Scala IDE specific (Scala & Java development for Eclipse)
101-
.cache-main
102-
.scala_dependencies
103-
.worksheet
104-
105-
# Uncomment this line if you wish to ignore the project description file.
106-
# Typically, this file would be tracked if it contains build/dependency configurations:
107-
.project
108-
109-
# https://github.com/github/gitignore/blob/master/Python.gitignore (modified)
110-
# ---------------------------------------------------------------------------
111-
112-
# Byte-compiled / optimized / DLL files
113-
__pycache__/
114-
*.py[cod]
115-
*$py.class
116-
117-
# C extensions
118-
*.so
119-
120-
# Distribution / packaging
121-
.Python
122-
build/
123-
develop-eggs/
124-
dist/
125-
downloads/
126-
eggs/
127-
.eggs/
128-
lib/
129-
lib64/
130-
parts/
131-
sdist/
132-
var/
133-
wheels/
134-
share/python-wheels/
135-
*.egg-info/
136-
.installed.cfg
137-
*.egg
138-
MANIFEST
139-
140-
# PyInstaller
141-
# Usually these files are written by a python script from a template
142-
# before PyInstaller builds the exe, so as to inject date/other infos into it.
143-
*.manifest
144-
*.spec
145-
146-
# Installer logs
147-
pip-log.txt
148-
pip-delete-this-directory.txt
149-
150-
# Unit test / coverage reports
151-
htmlcov/
152-
.tox/
153-
.nox/
154-
.coverage
155-
.coverage.*
156-
.cache
157-
nosetests.xml
158-
coverage.xml
159-
*.cover
160-
*.py,cover
161-
.hypothesis/
162-
.pytest_cache/
163-
cover/
164-
165-
# Translations
166-
*.mo
167-
*.pot
27+
# Compiled class files
28+
*.class
16829

169-
# Django stuff:
30+
# Log files
17031
*.log
171-
local_settings.py
172-
db.sqlite3
173-
db.sqlite3-journal
174-
175-
# Flask stuff:
176-
instance/
177-
.webassets-cache
178-
179-
# Scrapy stuff:
180-
.scrapy
181-
182-
# Sphinx documentation
183-
docs/_build/
184-
185-
# PyBuilder
186-
.pybuilder/
187-
target/
188-
189-
# Jupyter Notebook
190-
.ipynb_checkpoints
191-
192-
# IPython
193-
profile_default/
194-
ipython_config.py
195-
196-
# pyenv
197-
# For a library or package, you might want to ignore these files since the code is
198-
# intended to run in multiple environments; otherwise, check them in:
199-
.python-version
200-
201-
# pipenv
202-
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
203-
# However, in case of collaboration, if having platform-specific dependencies or dependencies
204-
# having no cross-platform support, pipenv may install dependencies that don't work, or not
205-
# install all needed dependencies.
206-
Pipfile.lock
207-
208-
# poetry
209-
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
210-
# This is especially recommended for binary packages to ensure reproducibility, and is more
211-
# commonly ignored for libraries.
212-
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
213-
poetry.lock
214-
215-
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
216-
__pypackages__/
217-
218-
# Celery stuff
219-
celerybeat-schedule
220-
celerybeat.pid
221-
222-
# SageMath parsed files
223-
*.sage.py
224-
225-
# Environments
226-
.env
227-
.venv
228-
env/
229-
venv/
230-
ENV/
231-
env.bak/
232-
venv.bak/
233-
234-
# Spyder project settings
235-
.spyderproject
236-
.spyproject
237-
238-
# Rope project settings
239-
.ropeproject
240-
241-
# mkdocs documentation
242-
/site
243-
244-
# mypy
245-
.mypy_cache/
246-
.dmypy.json
247-
dmypy.json
248-
249-
# Pyre type checker
250-
.pyre/
251-
252-
# pytype static type analyzer
253-
.pytype/
254-
255-
# Cython debug symbols
256-
cython_debug/
257-
258-
# PyCharm
259-
# JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
260-
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
261-
# and can be added to the global gitignore or merged into this file. For a more nuclear
262-
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
263-
.idea/
264-
265-
# https://github.com/github/gitignore/blob/master/Linux.gitignore
266-
# ---------------------------------------------------------------
267-
268-
*~
269-
270-
# temporary files which can be created if a process still has a handle open of a deleted file
271-
.fuse_hidden*
272-
273-
# KDE directory preferences
274-
.directory
275-
276-
# Linux trash folder which might appear on any partition or disk
277-
.Trash-*
278-
279-
# .nfs files are created when an open file is removed but is still being accessed
280-
.nfs*
281-
282-
# Extras
283-
# ------
284-
285-
# Not part of standard Eclipse gitignore for some reason.
286-
.classpath
287-

.pydevproject

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
<?eclipse-pydev version="1.0"?><pydev_project>
3+
<pydev_property name="org.python.pydev.PYTHON_PROJECT_INTERPRETER">Default</pydev_property>
4+
<pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python interpreter</pydev_property>
5+
</pydev_project>

0 commit comments

Comments
 (0)