Skip to content

Commit

Permalink
Prepare MP OpenAPI to Release. Add correct Licenses. (#452)
Browse files Browse the repository at this point in the history
  • Loading branch information
@radcortez
radcortez committed Nov 20, 2020
1 parent 793faad commit b7a437d
Show file tree
Hide file tree
Showing 14 changed files with 770 additions and 19 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/01-compatible-certification-request.md
View file
@@ -0,0 +1,27 @@
---
[Implementation Name]: Compatible Certification Request
about: Start a request for a compatible certification
title: 'MicroProfile OpenAPI [Version] Compatible Certification Request'
labels: 'Certification :trophy:'
assignees: ''

---

- [ ] Organization Name ("Organization") and, if applicable, URL:<br/>
// Add here
- [ ] Product Name, Version and download URL (if applicable):<br/>
// Add here
- [ ] Specification Name, Version and download URL:<br/>
// Add here
- [ ] (Optional) TCK Version, digital SHA-256 fingerprint and download URL:<br/>
// Add here
- [ ] Public URL of TCK Results Summary:<br/>
// Add here
- [ ] Any Additional Specification Certification Requirements:<br/>
// Add here
- [ ] Java runtime used to run the implementation:<br/>
// Add here
- [ ] Summary of the information for the certification environment, operating system, cloud, ...:<br/>
// Add here
- [ ] By checking this box I acknowledge that the Organization I represent accepts the terms of the [EFTL](https://www.eclipse.org/legal/tck.php).
- [ ] By checking this box I attest that all TCK requirements have been met, including any compatibility rules.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
View file
Expand Up @@ -15,7 +15,7 @@ jobs:
- uses: actions/checkout@v2
name: checkout

- uses: actions/setup-java@v1.3.0
- uses: actions/setup-java@v1
name: set up jdk ${{matrix.java}}
with:
java-version: ${{matrix.java}}
Expand Down
46 changes: 46 additions & 0 deletions api/pom.xml
View file
Expand Up @@ -38,9 +38,55 @@

<build>
<plugins>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>3.2.0</version>
<executions>
<execution>
<id>copy-resources</id>
<phase>validate</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${basedir}/target/apidocs/doc-files/</outputDirectory>
<overwrite>true</overwrite>
<resources>
<resource>
<directory>src/main/javadoc/licenses/${revremark}/</directory>
<filtering>true</filtering>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<failOnError>false</failOnError>
<docfilessubdirs>true</docfilessubdirs>
<attach>true</attach>
<doclint>none</doclint>
<doctitle>${project.name}</doctitle>
<windowtitle>${project.name}</windowtitle>
<header><![CDATA[<br>${project.name} v${project.version}]]></header>
<bottom>
<![CDATA[
Copyright &#169; ${inceptionYear} &#x2013; {currentYear} {organizationName}. All rights reserved.
<br>
Use is subject to <a href="{@docRoot}/doc-files/license.html" target="_top">license terms</a>.
]]>
</bottom>
<tags>
<tag>
<name>implSpec</name>
<placement>a</placement>
<head>Implementation Specification:</head>
</tag>
</tags>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
Expand Down
27 changes: 27 additions & 0 deletions api/src/main/javadoc/licenses/Draft/license.html
View file
@@ -0,0 +1,27 @@
<html>
<head>
<title>Apache License - Version 2</title>
</head>
<body>
<h1>Apache License - Version 2</h1>
<p>
Copyright (c) ${inceptionYear}-${currentYear} Contributors to the Eclipse Foundation
</p>
<p>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
</p>
<p>

http://www.apache.org/licenses/LICENSE-2.0
</p>
<p>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
</p>
</body>
</html>
72 changes: 72 additions & 0 deletions api/src/main/javadoc/licenses/Final/license.html
View file
@@ -0,0 +1,72 @@
<html>
<head>
<title>Eclipse Foundation Specification License - v1.0</title>
</head>
<body>
<h1>Eclipse Foundation Specification License - v1.0</h1>
<p>By using and/or copying this document, or the Eclipse Foundation
document from which this statement is linked, you (the licensee) agree
that you have read, understood, and will comply with the following
terms and conditions:</p>

<p>Permission to copy, and distribute the contents of this document, or
the Eclipse Foundation document from which this statement is linked, in
any medium for any purpose and without fee or royalty is hereby
granted, provided that you include the following on ALL copies of the
document, or portions thereof, that you use:</p>

<ul>
<li> link or URL to the original Eclipse Foundation document.</li>
<li>All existing copyright notices, or if one does not exist, a notice
(hypertext is preferred, but a textual representation is permitted)
of the form: &quot;Copyright &copy; [$date-of-document]
&ldquo;Eclipse Foundation, Inc. &lt;&lt;url to this license&gt;&gt;
&quot;
</li>
</ul>

<p>Inclusion of the full text of this NOTICE must be provided. We
request that authorship attribution be provided in any software,
documents, or other items or products that you create pursuant to the
implementation of the contents of this document, or any portion
thereof.</p>

<p>No right to create modifications or derivatives of Eclipse Foundation
documents is granted pursuant to this license, except anyone may
prepare and distribute derivative works and portions of this document
in software that implements the specification, in supporting materials
accompanying such software, and in documentation of such software,
PROVIDED that all such works include the notice below. HOWEVER, the
publication of derivative works of this document for use as a technical
specification is expressly prohibited.</p>

<p>The notice is:</p>

<p>&quot;Copyright &copy; [$date-of-document] Eclipse Foundation. This software or
document includes material copied from or derived from [title and URI
of the Eclipse Foundation specification document].&quot;</p>

<h2>Disclaimers</h2>

<p>THIS DOCUMENT IS PROVIDED &quot;AS IS,&quot; AND THE COPYRIGHT
HOLDERS AND THE ECLIPSE FOUNDATION MAKE NO REPRESENTATIONS OR
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THE DOCUMENT ARE
SUITABLE FOR ANY PURPOSE; NOR THAT THE IMPLEMENTATION OF SUCH CONTENTS
WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR
OTHER RIGHTS.</p>

<p>THE COPYRIGHT HOLDERS AND THE ECLIPSE FOUNDATION WILL NOT BE LIABLE
FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT
OF ANY USE OF THE DOCUMENT OR THE PERFORMANCE OR IMPLEMENTATION OF THE
CONTENTS THEREOF.</p>

<p>The name and trademarks of the copyright holders or the Eclipse
Foundation may NOT be used in advertising or publicity pertaining to
this document or its contents without specific, written prior
permission. Title to copyright in this document will at all times
remain with copyright holders.</p>

</body>
</html>
35 changes: 34 additions & 1 deletion pom.xml
View file
Expand Up @@ -53,6 +53,9 @@
<!-- Versions of SPEC dependencies -->
<asciidoctor-maven.version>1.6.0</asciidoctor-maven.version>
<asciidoctorj-pdf.version>1.5.3</asciidoctorj-pdf.version>

<revremark>Draft</revremark>
<inceptionYear>2017</inceptionYear>
</properties>

<licenses>
Expand All @@ -64,6 +67,11 @@
</license>
</licenses>

<organization>
<name>Eclipse Foundation</name>
<url>http://www.eclipse.org/</url>
</organization>

<developers>
<developer>
<name>Arthur De Magalhaes</name>
Expand Down Expand Up @@ -162,6 +170,11 @@
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<version>3.0.0</version>
</plugin>
</plugins>
</pluginManagement>
<plugins>
Expand Down Expand Up @@ -284,11 +297,31 @@
<exclude>**/*.ipr</exclude>
<exclude>**/.externalToolBuilders/*</exclude>
<exclude>nb**.xml</exclude>
<exclude>.github/**/*.*</exclude>
<exclude>.github/**</exclude>
<exclude>**/license.html</exclude>
<exclude>**/license-efsl.adoc</exclude>
<exclude>**/LICENSE*</exclude>
</excludes>
</configuration>
</plugin>

<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<executions>
<execution>
<id>timestamp-property</id>
<goals>
<goal>timestamp-property</goal>
</goals>
<phase>validate</phase>
<configuration>
<name>currentYear</name>
<pattern>yyyy</pattern>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>

Expand Down
49 changes: 36 additions & 13 deletions spec/pom.xml
View file
Expand Up @@ -29,10 +29,12 @@
<description>MicroProfile OpenAPI :: Specification</description>

<properties>
<license>Apache License v 2.0</license>
<asciidoctor-maven.version>1.5.6</asciidoctor-maven.version>
<asciidoctorj-pdf.version>1.5.0-alpha.15</asciidoctorj-pdf.version>
<maven.build.timestamp.format>MMMM dd, yyyy</maven.build.timestamp.format>
<revisiondate>${maven.build.timestamp}</revisiondate>
<revremark>Draft</revremark>
<spec.pdf>${project.build.directory}/generated-docs/${project.build.finalName}.pdf</spec.pdf>
<spec.html>${project.build.directory}/generated-docs/${project.build.finalName}.html</spec.html>
</properties>

<build>
Expand All @@ -57,12 +59,8 @@
<goal>process-asciidoc</goal>
</goals>
<configuration>
<outputFile>${spec.pdf}</outputFile>
<backend>pdf</backend>
<attributes>
<revnumber>${project.version}</revnumber>
<revremark>${revremark}</revremark>
<revdate>${revisiondate}</revdate>
</attributes>
</configuration>
</execution>
<execution>
Expand All @@ -72,23 +70,48 @@
<goal>process-asciidoc</goal>
</goals>
<configuration>
<outputFile>${spec.html}</outputFile>
<backend>html5</backend>
<attributes>
<revnumber>${project.version}</revnumber>
<revremark>${revremark}</revremark>
<revdate>${revisiondate}</revdate>
</attributes>
</configuration>
</execution>
</executions>
<configuration>
<sourceDocumentName>microprofile-openapi-spec.adoc</sourceDocumentName>
<sourceHighlighter>coderay</sourceHighlighter>
<attributes>
<license>${license}</license>
<revnumber>${project.version}</revnumber>
<revremark>${revremark}</revremark>
<revdate>${revisiondate}</revdate>
<currentYear>${currentYear}</currentYear>
<inceptionYear>${inceptionYear}</inceptionYear>
</attributes>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<executions>
<execution>
<id>attach-artifacts</id>
<phase>package</phase>
<goals>
<goal>attach-artifact</goal>
</goals>
<configuration>
<artifacts>
<artifact>
<file>${spec.pdf}</file>
<type>pdf</type>
</artifact>
<artifact>
<file>${spec.html}</file>
<type>html</type>
</artifact>
</artifacts>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>

Expand Down

0 comments on commit b7a437d

Please sign in to comment.