JarCasting
JarCasting JarCasting

Josman

Super POM common to open data trentino projects

Лицензия

Лицензия
Категории

Категории

Данные
Группа

Группа

eu.trentorise.opendata
Идентификатор

Идентификатор

josman
Последняя версия

Последняя версия

0.7.0
Дата

Дата
Тип

Тип

jar
Описание

Описание

Josman
Super POM common to open data trentino projects
Ссылка на сайт

Ссылка на сайт

https://github.com/opendatatrentino/josman
Организация-разработчик

Организация-разработчик

Trento Rise
Система контроля версий

Система контроля версий

https://github.com/opendatatrentino/josman

Скачать josman

Имя Файла Размер
josman-0.7.0.pom
josman-0.7.0.jar 3 MB
josman-0.7.0-tests.jar 16 KB
josman-0.7.0-sources.jar 3 MB
josman-0.7.0-javadoc.jar 58 KB
Обзор

Как подключить последнюю версию

<!-- https://jarcasting.com/artifacts/eu.trentorise.opendata/josman/ -->
<dependency>
    <groupId>eu.trentorise.opendata</groupId>
    <artifactId>josman</artifactId>
    <version>0.7.0</version>
</dependency>
// https://jarcasting.com/artifacts/eu.trentorise.opendata/josman/
implementation 'eu.trentorise.opendata:josman:0.7.0'
// https://jarcasting.com/artifacts/eu.trentorise.opendata/josman/
implementation ("eu.trentorise.opendata:josman:0.7.0")
'eu.trentorise.opendata:josman:jar:0.7.0'
<dependency org="eu.trentorise.opendata" name="josman" rev="0.7.0">
  <artifact name="josman" type="jar" />
</dependency>
@Grapes(
@Grab(group='eu.trentorise.opendata', module='josman', version='0.7.0')
)
libraryDependencies += "eu.trentorise.opendata" % "josman" % "0.7.0"
[eu.trentorise.opendata/josman "0.7.0"]

Зависимости

compile (11)

Идентификатор библиотеки Тип Версия
org.apache.maven : maven-plugin-api jar 3.0.5
org.eclipse.jgit : org.eclipse.jgit jar 3.7.0.201502260915-r
org.apache.maven : maven-project jar 3.0-alpha-2
commons-io : commons-io jar 2.2
org.parboiled : parboiled-java jar 1.1.7
org.jodd : jodd-lagarto jar 3.6.4
eu.trentorise.opendata : tod-commons jar 1.1.0
org.pegdown : pegdown jar 1.5.0
org.eclipse.mylyn.github : org.eclipse.egit.github.core jar 2.1.5
org.codehaus.plexus : plexus-utils jar 2.1
commons-cli : commons-cli jar 1.2

provided (1)

Идентификатор библиотеки Тип Версия
org.apache.maven.plugin-tools : maven-plugin-annotations jar 3.4

test (2)

Идентификатор библиотеки Тип Версия
junit : junit jar 4.12
org.hamcrest : hamcrest-core jar 1.3

Модули Проекта

Данный проект не имеет модулей.

WARNING: THIS PROJECT AS OF 0.8.0 HAS BEEN MERGED INTO JOSMAN-MAVEN-PLUGIN project. FOR OLDER VERSIONS OF JOSMAN, SEE PROJECT WEBSITE

About

Josman is a Java program to generate documentation for open source projects.

Project Status: still a prototype

Roadmap: See project milestones

Usage: Project is not published yet, so usage docs are subject to change.

License: business-friendly Apache License v2.0

Contributing: see the wiki

Main ideas

Josman is modeled after this workflow, where you:

  1. create an open source project on Github
  2. keep docs in source code, in folder docs/ (i.e. see josman docs)
  3. edit your markdown files and set relative links between them so they display nice in Github
  4. create a branch named master-x.y (i.e master-1.2) (until v0.7 we used name branch-x.y)
  5. release your library using semantic versioning and tag it with tagname projectName-x.y.z (i.e. josman-1.2.3)
  6. run Josman to create a corresponding github website (i.e. http://opendatatrentino.github.io/josman) out of the docs.
  7. spam the world with links to your new shiny project website

Project wiki (i.e. josman wiki) is used for information about contributing to the project.

This way we

  • fully exploit all the existing editing features of Github
  • reuse version information from git repo and Maven while generating the website
  • let Josman perform the tedious tasks like checking versions, fixing links, publishing javadoc, ..
  • evolve documention in separate branches
    • so if you have to patch something or just improve docs, just work in relative master-x.y and then run Josman to publish it (even if it is not released).
    • if you need to add functionality, create new branch named master-x.y+1

Credits

eu.trentorise.opendata

Open Data in Trentino

Версии библиотеки

Версия
0.7.0
0.6.1
0.6.0
0.5.0