Wiki Publisher Maven

DESCRIÇÃO

O Wiki Publisher Maven é um plugin do Maven 2 que tem como objetivo auxiliar a publicação
da documentação na Wiki do Redmine de um determinado projeto. O seu desenvolvimento
teve como motivação:

Eliminar a necessidade de um site específico para a documentação e relatórios como é feito no atual plugin site do maven. Deste modo a documentação fica centralizada com a gerência do projeto no Redmine.

Recursos que macros da Wiki oferecem na integração dos artefatos da documentação do projeto com tarefas, repositório svn e outras funcionalidades do Redmine.

Este plugin teve como referência e base o plugin Maven Redmine Plugin desenvolvido
por Julien Eluard.

Fastconnect Maven Site
Fastconnect Redmine

EQUIPE DE DESENVOLVIMENTO

O Wiki Publisher Maven foi desenvolvido por uma equipe da DIDE – Divisão de Desenvolvimento
do Núcleo de Tecnologia da Informação – UFMS

Daniel Camargo – daniel.camargo@ufms.br – danielsudpr@gmail.com
Heverson Vasconcelos – heverson.vasconcelos@aluno.ufms.br – heverson.vasconcelos@gmail.com
Rodrigo Kuninari – rodrigo.kuninari@aluno.ufms.br – rodrigokuninari@gmail.com
Vinícius Souza – vinicius.souza@aluno.ufms.br – viniciuspodi@gmail.com

CONFIGURAÇÕES

pom.xml

A maioria dos parâmetros utilizados no plugin é configurado a partir do arquivo pom.xml.
Exemplo:


<project>
	...
	<build>
		<plugins>
			<plugin>
				<groupId>br.ufms.nti</groupId>
				<artifactId>redmine-wiki-publisher</artifactId>
				<configuration>
					<projectIdentifier>${project.artifactId}</projectIdentifier>
					<redmineDatabase>redmine-postgresql</redmineDatabase>
					<redmineDatabaseUrl>jdbc:postgresql://debianvm:5432/redmine</redmineDatabaseUrl>
					<redmineDatabaseDriver>org.postgresql.Driver</redmineDatabaseDriver>
					<designDir>design</designDir>



						postgresql
						postgresql
						9.1-901-1.jdbc4



…


…

{maven2_installation_path}/conf/settings.xml

Neste arquivo deverá ser configurado a tag com o valor br.ufms.nti.
Exemplo:


<pluginGroups>
	...
	<pluginGroup>br.ufms.nti</pluginGroup>
	...
</pluginGroups>

As configurações de acesso ao banco de dados do redmine deverão ser configuradas
no arquivo settings.xml. Deste modo é possível armazenar as senhas criptografadas.
Exemplo:


<servers>
	...
	<server>
		<id>redmine-postgresql</id>
		<username>redmine</username>
		<password>{Kv/Gx43kBVEH8S8TB2LSy3umlM53U8aVaxpWGN/O0Jo=}</password>
	</server>
	...
</servers>

Em caso de dúvidas do procedimento para criptografar a senha de acesso ao banco
utilizando o maven, consulte Maven Password Encryption

Para maiores informações de como configurar um plugin do maven, consulte Maven Guide to Configuring Plug-ins

DEPENDÊNCIAS

Redmine SCMacros

Esse plugin faz uso de macros que não são reconhecidas pelo Redmine por padrão.
Utiliza a função repo_include do plugin scmacros do Redmine.
Essa função inclui um arquivo do repositório (svn, git, etc) na wiki do projeto.
Exemplo:



{{repo_include(design/gpr/index.textile)}}

JDBC Driver

Deverá ser especificado no pom.xml o driver jdbc do sgdb utilizado no Redmine.
Exemplo:


<build>
	...
	<plugins>
		...
		<plugin>
			<groupId>br.ufms.nti</groupId>
			<artifactId>wiki-publisher-maven</artifactId>
			<configuration>
				<projectIdentifier>${project.artifactId}</projectIdentifier>
				<redmineDatabase>redmine-postgresql</redmineDatabase>
				<redmineDatabaseUrl>jdbc:postgresql://debianvm:5432/redmine</redmineDatabaseUrl>
				<redmineDatabaseDriver>org.postgresql.Driver</redmineDatabaseDriver>
				<designDir>design</designDir>



					postgresql
					postgresql
					9.1-901-1.jdbc4



…

…

USO

Goals

publish-wiki
> Publica a documentação do projeto na Wiki do Redmine. O Wiki Publisher Maven irá exportar o conteúdo do diretório configurado na tag (seção de configurações do plugin no pom.xml), para páginas wiki.

Como executar

publish-wiki
```
mvn wiki-publisher-maven:publish-wiki
```

heversonvasconcelos/wiki_publisher_maven