Going Open Source - noi-techpark/documentation GitHub Wiki

Going Open Source

This article describes what you should do if you want to open a repository as free software.

NB: Currently only tested for Java/Maven projects with a plugin called license-maven-plugin.

  • Add a LICENSE folder (uppercase) to the repository's root folder
  • Add a license you like to that folder in plain text (ex., GPLv3)
  • Add a LICENSE/templates folder (ex., GPLv3-header)
  • Add a license-template to that folder
  • Add the license-maven-plugin to your pom.xml file as follows
            <plugin>
                <groupId>com.mycila</groupId>
                <artifactId>license-maven-plugin</artifactId>
                <version>3.0</version>
                <configuration>
                    <header>../LICENSE/templates/GPLv3-header</header>
                    <properties>
                        <owner>OpenDataHub</owner>
                        <email>[email protected]</email>
                    </properties>
                    <excludes>
                        <exclude>bin/**</exclude>
                        <exclude>**/README</exclude>
                        <exclude>src/test/resources/**</exclude>
                        <exclude>src/main/resources/**</exclude>
                    </excludes>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>check</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
  • Add missing project attributes to your pom.xml, for instance
    <inceptionYear>2018</inceptionYear>
    <description>Data Writer for the Big Data Platform</description>
  • Update your Maven Project and run mvn license:format
⚠️ **GitHub.com Fallback** ⚠️