Skip to content

Commit 3d740c2

Browse files
LeandroC89LeandroC89
committed
Merge branch 'master' into ExcelWriteNewSheet
# Conflicts: # dataframe-excel/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/xlsx.kt # dataframe-excel/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/XlsxTest.kt # docs/StardustDocs/topics/write.md # tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/Write.kt
2 parents b45557a + 03357b1 commit 3d740c2

File tree

1,095 files changed

+305681
-22035
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,095 files changed

+305681
-22035
lines changed

‎.editorconfig

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,10 @@ indent_size=4
77
max_line_length=120
88

99
[*.json]
10-
indent_size=2
10+
indent_size=2
11+
12+
[*.yaml]
13+
indent_size=2
14+
15+
[*.ipynb]
16+
insert_final_newline=false

‎.github/workflows/main.yml

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
name: Build docs
2+
3+
on:
4+
# Specify to run a workflow manually from the Actions tab on GitHub.
5+
workflow_dispatch:
6+
7+
# Gives the workflow permissions to clone the repo and create a page deployment
8+
permissions:
9+
id-token: write
10+
pages: write
11+
12+
env:
13+
PRODUCT: StardustDocs/d
14+
ARTIFACT: webHelpD2-all.zip
15+
ALGOLIA_ARTIFACT: algolia-indexes-D.zip
16+
ALGOLIA_APP_NAME: JWPLKSKZVF
17+
ALGOLIA_INDEX_NAME: prod_DATAFRAME_HELP
18+
ALGOLIA_KEY: ${{ secrets.ALGOLIA_KEY }}
19+
CONFIG_JSON_PRODUCT: Dataframe
20+
CONFIG_JSON_VERSION: '0.12'
21+
22+
jobs:
23+
build-job:
24+
runs-on: ubuntu-latest
25+
container: registry.jetbrains.team/p/writerside/builder/writerside-builder:2.1.1481-p3872-df
26+
outputs:
27+
artifact: ${{ steps.generate-artifact.outputs.artifact }}
28+
steps:
29+
- name: Checkout repository
30+
uses: actions/checkout@v3
31+
- name: Prepare for build
32+
run: |
33+
apt-get update
34+
apt-get install -y zip
35+
mkdir -p artifacts
36+
- name: Build docs and include sitemap.xml
37+
run: |
38+
export DISPLAY=:99
39+
Xvfb :99 &
40+
/opt/builder/bin/idea.sh helpbuilderinspect -source-dir . -product $PRODUCT --runner github -output-dir artifacts/ || true
41+
test -e artifacts/$ARTIFACT && echo $ARTIFACT exists
42+
cp docs/StardustDocs/sitemap.xml artifacts/sitemap.xml
43+
cd artifacts
44+
zip -r $ARTIFACT sitemap.xml
45+
working-directory: ${{ github.workspace }}
46+
- name: Upload modified documentation artifact
47+
uses: actions/upload-artifact@v3
48+
with:
49+
name: help
50+
path: artifacts/${{ env.ARTIFACT }}
51+
retention-days: 7
52+
- name: Upload algolia-indexes
53+
uses: actions/upload-artifact@v3
54+
with:
55+
name: algolia-indexes
56+
path: artifacts/${{ env.ALGOLIA_ARTIFACT }}
57+
retention-days: 7
58+
59+
deploy:
60+
environment:
61+
name: github-pages
62+
url: ${{ steps.deployment.outputs.page_url }}
63+
# Requires the build-job results
64+
needs: build-job
65+
runs-on: ubuntu-latest
66+
steps:
67+
- name: Download artifact
68+
uses: actions/download-artifact@v3
69+
with:
70+
name: help
71+
- name: Unzip artifact
72+
uses: montudor/action-zip@v1
73+
with:
74+
args: unzip -qq ${{ env.ARTIFACT }} -d dir
75+
- name: Setup Pages
76+
uses: actions/configure-pages@v2
77+
- name: Upload artifact
78+
uses: actions/upload-pages-artifact@v1
79+
with:
80+
path: dir
81+
- name: Deploy to GitHub Pages
82+
id: deployment
83+
uses: actions/deploy-pages@v1
84+
85+
publish-indexes:
86+
# Requires the build-job results
87+
needs: build-job
88+
runs-on: ubuntu-latest
89+
container:
90+
image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-2
91+
92+
steps:
93+
- uses: actions/checkout@v3
94+
- uses: actions/download-artifact@v3
95+
with:
96+
name: algolia-indexes
97+
- uses: montudor/action-zip@v1
98+
with:
99+
args: unzip -qq algolia-indexes-D.zip -d algolia-indexes
100+
- run: |
101+
env "algolia-key=${{env.ALGOLIA_KEY}}" java -jar /opt/builder/help-publication-agent.jar \
102+
update-index \
103+
--application-name ${{env.ALGOLIA_APP_NAME}} \
104+
--index-name ${{env.ALGOLIA_INDEX_NAME}} \
105+
--product ${{env.CONFIG_JSON_PRODUCT}} \
106+
--version ${{env.CONFIG_JSON_VERSION}} \
107+
--index-directory algolia-indexes/ \
108+
2>&1 | tee algolia-update-index-log.txt

‎.space.kts

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import java.nio.file.Files
2+
import java.nio.file.Paths
3+
4+
job("Polaris Artifact") {
5+
container("registry.jetbrains.team/p/sa/public/qodana-jvm:polaris") {
6+
kotlinScript { api ->
7+
val spaceProjectKey = System.getenv("JB_SPACE_PROJECT_KEY")
8+
val repoName = System.getenv("JB_SPACE_GIT_REPOSITORY_NAME")
9+
val initialPath = System.getenv("JB_SPACE_FILE_SHARE_PATH")
10+
val tid: String = api.space().projects.getProject(ProjectIdentifier.Key(spaceProjectKey)) {
11+
repos {
12+
id()
13+
name()
14+
}
15+
}.repos.first { it.name == repoName }.id!!
16+
Files.write(Paths.get("$initialPath/tid"), tid.encodeToByteArray())
17+
}
18+
}
19+
container("registry.jetbrains.team/p/sa/public/qodana-jvm:polaris")
20+
}

‎CONTRIBUTING.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Contributing Guidelines
2+
3+
There are two main ways to contribute to the project — submitting issues and submitting
4+
fixes/changes/improvements via pull requests.
5+
6+
## Submitting issues
7+
8+
Both bug reports and feature requests are welcome.
9+
Submit issues [here](https://github.com/Kotlin/dataframe/issues).
10+
11+
* Search for existing issues to avoid reporting duplicates.
12+
* When submitting a bug report:
13+
* Test it against the most recently released version. It might have already been fixed.
14+
* Include the code reproducing the problem or attach the link to the repository with the project that fully reproduces the problem.
15+
* However, don't put off reporting any weird or rarely appearing issues just because you cannot consistently
16+
reproduce them.
17+
* If the bug is in behavior, then explain what behavior you've expected and what you've got.
18+
* When submitting a feature request:
19+
* Explain why you need the feature &mdash, your use case, and your domain.
20+
* Explaining the problem you face is more important than suggesting a solution.
21+
Report your issue even if you don't have any proposed solution.
22+
* If there is an alternative way to do what you need, show the alternative's code.
23+
24+
25+
## Submitting PRs
26+
27+
We love PRs. Submit PRs [here](https://github.com/Kotlin/dataframe/pulls).
28+
However, please keep in mind that maintainers will have to support the resulting code of the project,
29+
so do familiarize yourself with the following guidelines.
30+
31+
* All development (both new features and bug fixes) is performed in the `master` branch.
32+
* Base PRs against the `master` branch.
33+
* PR should be linked with the issue,
34+
excluding minor documentation changes, adding unit tests, and fixing typos.
35+
* If you make any code changes:
36+
* Follow the [Kotlin Coding Conventions](https://kotlinlang.org/docs/reference/coding-conventions.html).
37+
* [Build the project](#building) to ensure it all works and passes the tests.
38+
* If you fix a bug:
39+
* Write the test that reproduces the bug.
40+
* Fixes without tests are accepted only in exceptional circumstances if it can be shown that writing the
41+
corresponding test is too hard or otherwise impractical.
42+
* If you introduce any new public APIs:
43+
* All new APIs must come with documentation and tests.
44+
* If you plan API additions, please start by submitting an issue with the proposed API design
45+
to gather community feedback.
46+
* [Contact the maintainers](#contacting-maintainers) to coordinate any great work in advance via submitting an issue.
47+
* If you fix documentation:
48+
* If you plan extensive rewrites/additions to the docs, then please [contact the maintainers](#contacting-maintainers)
49+
to coordinate the work in advance.
50+
* Also, we have a special simple [guide](https://github.com/Kotlin/dataframe/blob/master/docs/contributions.md) how to contribute in the documentation.
51+
52+
## PR workflow
53+
54+
0. The contributor builds the library locally and runs all unit tests via the Gradle task `dataframe:test`
55+
(see the ["Building"](#building) chapter).
56+
1. The contributor submits the PR if the local build is successful and the tests are green.
57+
2. The reviewer put his name in the "Reviewers" section of the proposed PR at the start of the review process.
58+
3. The reviewer leaves the comments or marks the PR with the abbreviation "LGTM" (Looks good to me).
59+
4. The contributor answers the comments or fixes the proposed PR.
60+
5. The reviewer marks the PR with the word "LGTM."
61+
6. The maintainer could suggest merging the master branch to the PR branch a few times due to changes in the `master` branch.
62+
7. The maintainer runs TC builds (unit tests and examples as integration tests).
63+
8. TC writes the result (passed or not passed) to the PR checks at the bottom of the proposed PR.
64+
9. If it is possible, maintainers share the details of the failed build with the contributor.
65+
10. Maintainer merges the PR if all checks are successful and there is no conflict with the master branch.
66+
67+
## How to fix an existing issue
68+
69+
* If you are going to work on the existing issue:
70+
* Comment on the existing issue if you want to work on it.
71+
* Wait till it is assigned to you by [maintainers](#contacting-maintainers).
72+
* Ensure that the issue describes a problem and a solution that has received positive feedback. Propose a solution if there isn't any.
73+
* If you are going to submit your first PR in this project:
74+
* Find tickets with the label ["good first issue"](https://github.com/Kotlin/dataframe/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee)
75+
which are not assigned to somebody.
76+
* Learn the [`examples`](https://github.com/Kotlin/dataframe/tree/master/examples) module. Submit an interesting new example or improve documentation for one of them.
77+
* If you are ready to participate in library design and new experiments, find tickets with the label
78+
["research"](https://github.com/Kotlin/dataframe/issues?q=is%3Aissue+is%3Aopen+label%3Aresearch)
79+
or join our [discussions](https://github.com/Kotlin/dataframe/discussions).
80+
81+
82+
## Environment requirements
83+
84+
JDK >= 11 referred to by the `JAVA_HOME` environment variable.
85+
86+
## Building
87+
88+
This library is built with Gradle.
89+
90+
* Run `./gradlew build` to build. It also runs all the tests.
91+
* Run `./gradlew <module>:test` to test the module you are looking at to speed
92+
things up during development.
93+
94+
You can import this project into IDEA, but you have to delegate the build actions
95+
to Gradle (in Preferences -> Build, Execution, Deployment -> Build Tools -> Gradle -> Runner)
96+
97+
## Contacting maintainers
98+
99+
* If something cannot be done or doesn't work conveniently &mdash; submit an [issue](#submitting-issues).
100+
* To attract attention to your problem, raise a question, or make a new comment, mention one of us on Github: @koperagen @Jolanrensen @zaleslaw @ileasile
101+
* Discussions and general inquiries &mdash; use `#datascience` channel in [KotlinLang Slack](https://kotl.in/slack).

0 commit comments

Comments
 (0)