Generating a Gitlab Wiki Page that references or includes various files

This program recursively scans a directory looking for files of different types to generate a link or include the content in the new generated wiki page.

The types of files searched are:

• csv
• jtl
• xml
• gz
• zip
• log
• gif
• png
• bmp
• jpg
• jpeg
• html

The link is "<a ref=" url file attachement in gitlab for files of type: csv, jtl, xml, gz, zip, log (to download it)

The link is "<img src=" url file attachement in gitlab for files of type: gif, png, bmp, jpg, jpeg (to view it)

For html files, the content is read and included in the generated html page but css is removed (blocks of html tables created with the csv-report-to-html tool from csv file), except for index.html file

Sorting algorithm : Filenames with less directory deep are before file this directory

Example : z.img < dir/x.img < dir/y.img < aa/bb/c.img < aa/bb/d.img
Deep    : no dir, dir 1 deep level,      dir 2 deep level

License

See the LICENSE file Apache 2 https://www.apache.org/licenses/LICENSE-2.0

The wiki page generated

Gitlab wiki page extract example 1 :

Gitlab wiki page extract example 2 :

Usage Maven

The maven groupId, artifactId and version, this plugin is in the Maven Central Repository

<groupId>io.github.vdaburon</groupId>
<artifactId>create-gitlab-wiki-page-for-files-in-directory</artifactId>
<version>1.1</version>

Just include the plugin in your pom.xml and execute mvn verify
or with parameters overwriting properties mvn -DgitlabUrl=https://mygitlab.com -DprojectId=12344 -DaccessToken=SLKJtokenLMJI -DpageTitle="Load test 05_03_2023" verify
or individual launch mvn -DaccessToken=mytokenLMJI exec:java@create_gitlab_wiki_page_for_files_in_directory

<project>
    <properties>
        <gitlabUrl>https://mygitlab.com</gitlabUrl>
        <projectId>my_project_id_148609</projectId>
        <accessToken>my_access_token_PkJ007</accessToken>
        <graph_width>900</graph_width>
        <dirWithFile>${project.build.directory}/jmeter/results</dirWithFile>
        <pageTitle>Load test 05_03_2023</pageTitle>
    </properties>

    <dependencies>
        <dependency>
            <groupId>io.github.vdaburon</groupId>
            <artifactId>create-gitlab-wiki-page-for-files-in-directory</artifactId>
            <version>1.1</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>exec-maven-plugin</artifactId>
                <version>1.2.1</version>
                <executions>
                    <execution>
                        <id>create_wiki_page_for_files_in_directory</id>
                        <phase>verify</phase>
                        <goals>
                            <goal>java</goal>
                        </goals>
                        <configuration>
                            <mainClass>io.github.vdaburon.jmeter.utils.WikiPageGenerator</mainClass>
                            <arguments>
                                <argument>-gitlabUrl</argument>
                                <argument>${gitlabUrl}</argument>
                                <argument>-projectId</argument>
                                <argument>${projectId}</argument>
                                <argument>-accessToken</argument>
                                <argument>${accessToken}</argument>
                                <argument>-dirWithFile</argument>
                                <argument>${dirWithFile}</argument>
                                <argument>-imageWidth</argument>
                                <argument>${graph_width}</argument>
                                <argument>-pageTitle</argument>
                                <argument>${pageTitle}</argument>
                            </arguments>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

Simple jar tool

This tool is a java jar, so it's could be use as simple jar (look at https://github.com/vdaburon/CreateGitlabWikiPageForFilesInDirectory/releases to download jar file)

java -jar create-gitlab-wiki-page-for-files-in-directory-<version>.jar -gitlabUrl https://mygitlab.com -projectId 148609 -accessToken WaBcDefNwHzJ44dPkJ007 -dirWithFile C:/result -imageWidth 950

Link to others projects

Usally this plugin is use with jmeter-graph-tool-maven-plugin
and this plugin csv-report-to-html

1. The jmeter-graph-tool-maven-plugin create the report csv files and graphs
2. The csv-report-to-html create the html table report from the csv file

Versions

Version 1.1 change default Wiki Page Title and the Date Format to be more compatible with slug link (remove ':')
Version 1.0 initial version test with Gitlab version 15.10