Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify Gradle layout, + KNIT, - ANK and fix site code fences #2584

Merged
merged 30 commits into from Dec 1, 2021
Merged
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
8ba5701
Remove nested Gradle config
JavierSegoviaCordoba Oct 31, 2021
2e706dd
Remove Ank and Dokka Workaround plugin
JavierSegoviaCordoba Nov 15, 2021
bbad393
Merge remote-tracking branch 'origin/main' into add-knit
JavierSegoviaCordoba Nov 15, 2021
69d2aca
Progress with knit fixing imports
JavierSegoviaCordoba Nov 15, 2021
20e98cf
knit generated examples compiling
raulraja Nov 16, 2021
0cc13b6
knit generated examples compiling
raulraja Nov 16, 2021
2a31066
make snippets -new
raulraja Nov 16, 2021
695bc6b
Update Arrow Core KNIT tags
nomisRev Nov 16, 2021
951a853
Update Arrow Fx Coroutines KNIT tags
nomisRev Nov 16, 2021
415d287
Updatee Arrow Fx STM KNIT tags
nomisRev Nov 16, 2021
d810816
Update Arrow Fx Coroutines Test KNIT tags
nomisRev Nov 16, 2021
1d478f9
Update Arrow Optics KNIT tags
nomisRev Nov 16, 2021
2dcaf30
Explicitely point to arrow-libs
nomisRev Nov 16, 2021
7d8a18d
Remove comments
nomisRev Nov 16, 2021
bd5dfaf
make examples compile
raulraja Nov 16, 2021
4bab0c5
Merge remote-tracking branch 'origin/main' into add-knit
JavierSegoviaCordoba Nov 22, 2021
ea70816
Progress with knit fixing imports in Validated
JavierSegoviaCordoba Nov 22, 2021
b3a29b6
Progress with knit fixing imports in Validated (INCLUDES)
JavierSegoviaCordoba Nov 23, 2021
c9af38c
more knit fixes
raulraja Nov 25, 2021
1d54d25
remove knit test examples
raulraja Nov 25, 2021
f2dec6b
knit fixes for retrofit example
raulraja Nov 25, 2021
9cdf263
attempt to fix pull request workflow build
raulraja Nov 28, 2021
8ac9b1c
code fences showing but strange character `\` appearing in code fences
raulraja Nov 28, 2021
ccb6324
attempt to fix code fences in docs
raulraja Nov 29, 2021
48aa8a4
fix result computation and Option knit examples
raulraja Nov 29, 2021
1e67418
knit fixes for Ior
raulraja Nov 30, 2021
8349d43
fixes for Either, Validated and Option
Dec 1, 2021
6ae97da
resolve compile error
Dec 1, 2021
adfeae9
resolve compile error
Dec 1, 2021
801d211
Update the doc publish workflow
franciscodr Dec 1, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 4 additions & 0 deletions .editorconfig
@@ -0,0 +1,4 @@
[*.{kt,kts}]
indent_size = 2
insert_final_newline = true
max_line_length = off
17 changes: 1 addition & 16 deletions .github/workflows/publish.yml
Expand Up @@ -58,7 +58,6 @@ jobs:
run: ${GITHUB_WORKSPACE}/.github/scripts/show-env.sh

- name: Publish Apple, Linux, JVM & JS targets
working-directory: arrow-libs
run: |
./gradlew publishToSonatype
echo "$(cat $BASEDIR/gradle.properties | grep projects.version | cut -d'=' -f2) Apple, Linux, JVM & JS deployed!"
Expand Down Expand Up @@ -96,7 +95,6 @@ jobs:
shell: bash

- name: Publish Windows
working-directory: arrow-libs
run: |
./gradlew publishToSonatype
echo "$(cat gradle.properties | grep projects.version | cut -d'=' -f2) MingwX64 deployed!"
Expand Down Expand Up @@ -134,69 +132,58 @@ jobs:
run: ${GITHUB_WORKSPACE}/.github/scripts/show-env.sh

- name: "Prepare environment"
working-directory: arrow-site
run: |
mkdir $BASEDIR/logs
brew install tree
bundle install --gemfile Gemfile --path vendor/bundle

- name: "Assemble"
working-directory: arrow-libs
run: |
echo "Additional step to avoid a random failure with Dokka 0.10.0 and MPP"
./gradlew assemble

- name: "Create API doc"
working-directory: arrow-libs
run: ./gradlew --no-parallel dokkaGfm

- name: "Validate documentation"
working-directory: arrow-site
run: ./gradlew runAnk
run: ./gradlew arrow-site:runAnk

- name: "Landing page: build"
if: ${{ env.NEW_RELEASE_VERSION_EXISTS == '1' && github.ref == 'refs/heads/main' }}
working-directory: arrow-site
run: |
bundle exec jekyll build -b docs -s build/site
tree _site > $BASEDIR/logs/content.log

- name: "Landing page: publish"
if: ${{ env.NEW_RELEASE_VERSION_EXISTS == '1' && github.ref == 'refs/heads/main' }}
working-directory: arrow-site
run: |
echo ">>> Landing page" >> $BASEDIR/logs/aws_sync.log
${GITHUB_WORKSPACE}/.github/scripts/publish-landing-page.sh

- name: "Remove index for versions"
working-directory: arrow-site
run: rm -f build/site/index.md

- name: "Latest release: build (docs/)"
if: ${{ env.NEW_RELEASE_VERSION_EXISTS == '1' && github.ref == 'refs/heads/main' }}
working-directory: arrow-site
run: |
bundle exec jekyll build -b docs -s build/site
tree _site > $BASEDIR/logs/content_docs.log

- name: "Latest release: publish (docs/)"
if: ${{ env.NEW_RELEASE_VERSION_EXISTS == '1' && github.ref == 'refs/heads/main' }}
working-directory: arrow-site
run: |
echo ">>> Latest release" >> $BASEDIR/logs/aws_sync.log
${GITHUB_WORKSPACE}/.github/scripts/publish-latest-release.sh

- name: "Latest release: build release directory (docs/<major.minor>)"
if: env.NEW_RELEASE_VERSION_EXISTS == '1'
working-directory: arrow-site
run: |
SHORT_VERSION=$(echo $RELEASE_VERSION | cut -d. -f1-2)
bundle exec jekyll build -b docs/${SHORT_VERSION} -s build/site
tree _site > $BASEDIR/logs/content_docs-${SHORT_VERSION}.log

- name: "Latest release: publish release directory (docs/<major.minor>)"
if: env.NEW_RELEASE_VERSION_EXISTS == '1'
working-directory: arrow-site
run: |
SHORT_VERSION=$(echo $RELEASE_VERSION | cut -d. -f1-2)
echo ">>> $SHORT_VERSION VERSION" >> $BASEDIR/logs/aws_sync.log
Expand All @@ -208,14 +195,12 @@ jobs:

- name: "Next version: build (/docs/next)"
if: ${{ github.ref == 'refs/heads/main' }}
working-directory: arrow-site
run: |
bundle exec jekyll build -b docs/next -s build/site
tree _site > $BASEDIR/logs/content_docs-next.log

- name: "Next version: publish (/docs/next)"
if: ${{ github.ref == 'refs/heads/main' }}
working-directory: arrow-site
run: |
echo ">>> NEXT VERSION" >> $BASEDIR/logs/aws_sync.log
aws s3 sync _site s3://$S3_BUCKET/docs/next --delete >> $BASEDIR/logs/aws_sync.log
Expand Down
17 changes: 5 additions & 12 deletions .github/workflows/pull_request.yml
Expand Up @@ -8,7 +8,7 @@ env:
GRADLE_OPTS: "-Dorg.gradle.daemon=false -Dorg.gradle.configureondemand=true -Dorg.gradle.jvmargs=-Xmx3g -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8"

jobs:
ktlint_dokka_ank:
code_formatter_dokka_ank:
runs-on: ubuntu-latest
timeout-minutes: 60

Expand Down Expand Up @@ -37,20 +37,16 @@ jobs:
echo "JAVA_HOME=$JAVA_HOME_8_X64" >> $GITHUB_ENV

- name: "ApiCheck"
working-directory: arrow-libs
run: ./gradlew apiCheck

- name: "Run KtLint"
working-directory: arrow-libs
run: ./gradlew ktlintCheck
# - name: "Run code formatter"
# run: ./gradlew spotlessCheck

- name: "Create API doc"
working-directory: arrow-libs
run: ./gradlew dokkaGfm

- name: "Validate documentation"
working-directory: arrow-site
run: ./gradlew runAnk
# - name: "Validate documentation"
# run: ./gradlew arrow-site:runAnk

- name: Stop Gradle daemons
run: ./gradlew --stop
Expand All @@ -77,7 +73,6 @@ jobs:
linux-step-gradle-

- name: Build
working-directory: arrow-libs
run: ./gradlew linuxX64Test jvmTest jsTest

- name: "Prepare test reports"
Expand Down Expand Up @@ -121,7 +116,6 @@ jobs:
mac-step-gradle-

- name: Build
working-directory: arrow-libs
run: ./gradlew iosX64Test macosX64Test tvosX64Test watchosX64Test

- name: "Prepare test reports"
Expand Down Expand Up @@ -166,7 +160,6 @@ jobs:
${{ runner.os }}-gradle-

- name: Build
working-directory: arrow-libs
run: ./gradlew mingwX64Test

- name: Stop Gradle daemons
Expand Down
6 changes: 6 additions & 0 deletions .gitignore
Expand Up @@ -137,3 +137,9 @@ target/

.bash_profile
**/.kotlintest/


_site/
.sass-cache/
.jekyll-cache/
.jekyll-metadata
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -95,7 +95,7 @@ for example
*
* The example below shows a refined type `Positive` that ensures [Int] is > than 0.
*
* ```kotlin:ank
* ```kotlin
* import arrow.refinement.Refined
* import arrow.refinement.ensure
*
Expand All @@ -106,6 +106,7 @@ for example
* })
* }
* ```
* <!--- KNIT example-contributing-new.kt -->
*/
abstract class Refined<A, out B>
```
Expand Down
6 changes: 0 additions & 6 deletions arrow-libs/.editorconfig

This file was deleted.

1 change: 0 additions & 1 deletion arrow-libs/ank/.editorconfig

This file was deleted.