Skip to content

Commit

Permalink
Initial import
Browse files Browse the repository at this point in the history
  • Loading branch information
vietj committed Jul 7, 2023
1 parent 35b6f51 commit d21fe6a
Show file tree
Hide file tree
Showing 4 changed files with 113 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/asciidoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: asciidoc
on:
push:
branches:
- master
schedule:
- cron: '0 4 * * *'
jobs:
Test:
name: Build asciidoc
strategy:
matrix:
os: [ubuntu-latest]
jdk: [8]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Install JDK
uses: joschi/setup-jdk@v2
with:
java-version: ${{ matrix.jdk }}
- name: Render asciidoc
run: mvn generate-resources
- name: Publish to GitHub Pages
uses: JamesIves/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
BRANCH: gh-pages
FOLDER: target/docs/vertx-5-migration-guide
CLEAN: true
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# 👓 [migration guide](https://vert-x3.github.io/vertx-5-migration-guide/index.html)

This is a live guide that is improved over time, if you believe there is a missing concern, open an issue or help us with a contribution to improve the community experience.

# Could'nt find what you are looking for ? 👊 [an issue](https://github.com/vert-x3/vertx-5-migration-guide/issues)

You can open an issue or contribute when you did not find what you were looking for.
6 changes: 6 additions & 0 deletions asciidoc/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
ECLIPSE VERT.X 5 MIGRATION GUIDE

This guide describes the updates in Eclipse Vert.x {v5} release. Use the information to upgrade your {VertX} {v4x} applications to {VertX} {v5}. It provides information about the new, deprecated and unsupported features in this release.

Depending on the modules used in your application, you can read the relevant section to know more about the changes in {VertX} {v5}.

69 changes: 69 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<?xml version="1.0"?>
<!--
~ Copyright (c) 2011-2019 Contributors to the Eclipse Foundation
~
~ This program and the accompanying materials are made available under the
~ terms of the Eclipse Public License 2.0 which is available at
~
~ http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
~ which is available at https://www.apache.org/licenses/LICENSE-2.0.
~
~ SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
~
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>io.vertx</groupId>
<artifactId>vertx-parent</artifactId>
<version>17</version>
</parent>

<artifactId>vertx-4-migration-guide</artifactId>
<version>1.0.0-SNASHOT</version>

<name>Vert.x 4 Migration Guide</name>

<licenses>
<license>
<name>The Apache Software License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
<distribution>repo</distribution>
</license>
<license>
<name>Eclipse Public License - v 2.0</name>
<url>http://www.eclipse.org/legal/epl-v20.html</url>
<distribution>repo</distribution>
</license>
</licenses>

<build>
<plugins>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>1.5.6</version>
<configuration>
<sourceDirectory>${basedir}/asciidoc</sourceDirectory>
<sourceDocumentName>index.adoc</sourceDocumentName>
<attributes>
<VertX>Vert.x</VertX>
<v4x>4.x</v4x>
<v5>5</v5>
<toc>left</toc>
</attributes>
</configuration>
<executions>
<execution>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

</project>

0 comments on commit d21fe6a

Please sign in to comment.