Skip to content

Commit 58c37f9

Browse files
authored
Remove legacy script files (#3034)
* Update markdown files * Remove unnecessary scripts
1 parent 563a735 commit 58c37f9

File tree

8 files changed

+24
-81
lines changed

8 files changed

+24
-81
lines changed

.github/scripts/create-sitemap.sh

-14
This file was deleted.

.github/scripts/sync-docs-with-aws.sh

-17
This file was deleted.

.github/scripts/sync-main-with-aws.sh

-19
This file was deleted.

CONTRIBUTING.md

+21-20
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ In this page you'll find these guidelines for contributions:
1515

1616
- [How to build the libraries](#how-to-build-the-libraries)
1717
- [How to generate and validate the documentation](#how-to-generate-and-validate-the-documentation)
18-
- [How to run the website in your local workspace](#how-to-run-the-website-in-your-local-workspace)
1918
- [How to propose an improvement](#how-to-propose-an-improvement)
2019
- [Notes](#notes)
2120
- [How to upgrade Gradle](#how-to-upgrade-gradle)
@@ -55,7 +54,7 @@ Root project 'arrow'
5554
+--- Project ':arrow-core'
5655
```
5756

58-
2. Append `:build` after the subproject name and run this task. See also Gradle documentation [how to run subproject tasks.](https://docs.gradle.org/current/userguide/intro_multi_project_builds.html#sec:executing_tasks_by_fully_qualified_name)
57+
2. Append `:build` after the subproject name and run this task. See also Gradle documentation [how to run subproject tasks.](https://docs.gradle.org/current/userguide/intro_multi_project_builds.html#sec:executing_tasks_by_fully_qualified_name)
5958

6059
```bash
6160
./gradlew :arrow-core:build
@@ -127,19 +126,21 @@ for example
127126
* println("value = $someValue")
128127
* println("emptyValue = $emptyValue")
129128
* }
130-
* ```
129+
*
131130
* <!--- KNIT example-option-01.kt -->
132131
*
133132
* (...)
134133
*/
135134
public sealed class Option<out A> {
135+
136+
}
136137
```
137138

138139
#### 2. Snippets for broader samples
139140

140141
If your snippet is showing examples on how to use the public APIs in a broader scenario (like describing FP patterns or similar), then you'll add those snippets to the described docs Markdown file.
141142

142-
## How to propose an improvement
143+
## How to propose an improvement
143144

144145
If it's the first time you contribute with a GitHub repository, take a look at [Collaborating with issues and pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests).
145146

@@ -149,11 +150,11 @@ Please, follow the link to [create an issue](https://github.com/arrow-kt/arrow/i
149150

150151
### How to create a pull request
151152

152-
The easiest way to contribute to Arrow is to create a branch from a fork, and then create a PR on Github from your branch.
153+
The easiest way to contribute to Arrow is to create a branch from a fork, and then create a PR on GitHub from your branch.
153154

154155
Arrow is a large project that uses several tools to verify that the code is formatted consistently, and that we don't break downstream projects that rely on Arrow's API across versions.
155156

156-
For code formatting we use [Spotless](https://github.com/diffplug/spotless/tree/main/plugin-gradle) with [KtFmt](https://github.com/facebookincubator/ktfmt) and for API binary compatibility we use [Binary Compatibility Validator](https://github.com/Kotlin/binary-compatibility-validator). They need to run before you commit and push your code to Github.
157+
For code formatting we use [Spotless](https://github.com/diffplug/spotless/tree/main/plugin-gradle) with [KtFmt](https://github.com/facebookincubator/ktfmt) and for API binary compatibility we use [Binary Compatibility Validator](https://github.com/Kotlin/binary-compatibility-validator). They need to run before you commit and push your code to GitHub.
157158

158159
If you've included those changes for binary compatibility and formatted the code correctly it's time to open your PR and get your contribution into Arrow. Thanks ahead of time for your effort and contributions 🙏
159160

@@ -180,7 +181,7 @@ Note: if, when running `build`, you see the following error:
180181
> Task :arrow-core:apiCheck FAILED
181182
```
182183

183-
This means you have changed (advertently or not) some public API. In this case read in the next point below how to resolve this.
184+
This means you have changed (inadvertently or not) some public API. In this case read in the next point below how to resolve this.
184185

185186
* The approval by 2 maintainers of the Arrow Community.
186187

@@ -234,11 +235,11 @@ This will generate updated `.api` files which you can then manually review (if t
234235

235236
Both successful or failed build checks allow to download the tests report to review it:
236237

237-
![how-to-download-tests-report](img/doc/download-report.png)
238+
![how-to-download-tests-report](static/img/doc/download-report.png)
238239

239240
#### What happens when merging a pull request
240241

241-
When merging the pull request, a new SNAPSHOT library will be published into [Sonatype OSSRH](https://oss.sonatype.org/service/local/repositories/snapshots/content/io/arrow-kt/).
242+
When merging the pull request, a new SNAPSHOT library will be published into [Sonatype OSS](https://oss.sonatype.org/service/local/repositories/snapshots/content/io/arrow-kt/).
242243

243244
On the other hand, the documentation for the next version (SNAPSHOT) will be updated:
244245

@@ -254,7 +255,7 @@ If any of these actions fails, an issue will be created to be solved as soon as
254255

255256
The use of Gradle appears in several subprojects: `arrow-core`, `arrow-stack`, etc.
256257

257-
However, links are being used so it's just necessary to upgrade Gradle in the project root directory:
258+
However, links are being used, so it's just necessary to upgrade Gradle in the project root directory:
258259

259260
```
260261
./gradlew wrapper --gradle-version <new-version>
@@ -269,16 +270,16 @@ This short guideline provides all the things to keep in mind when adding a new m
269270
- Add `<module>/build.gradle.kts`
270271
- Update `settings.gradle.kts`
271272
- Utilities:
272-
- Update BOM file: [build.gradle](arrow-stack/build.gradle)
273+
- Update BOM file: [build.gradle](arrow-libs/stack/build.gradle.kts)
273274

274275
### Gradle dependency configurations
275276

276-
| Configuration | Use | Note |
277-
| ------------- | --- | ---- |
278-
| `api` | compilation | exported to consumers for compilation |
279-
| `implementation` | compilation + runtime | exported to consumers for runtime |
280-
| `compileOnly` | just compilation | not exported to consumers |
281-
| `runtimeOnly` | just runtime | exported to consumers for runtime |
282-
| `testImplementation` | test compilation + test runtime | |
283-
| `testCompileOnly` | test compilation | |
284-
| `testRuntimeOnly` | test runtime | |
277+
| Configuration | Use | Note |
278+
|----------------------|---------------------------------|---------------------------------------|
279+
| `api` | compilation | exported to consumers for compilation |
280+
| `implementation` | compilation + runtime | exported to consumers for runtime |
281+
| `compileOnly` | just compilation | not exported to consumers |
282+
| `runtimeOnly` | just runtime | exported to consumers for runtime |
283+
| `testImplementation` | test compilation + test runtime | |
284+
| `testCompileOnly` | test compilation | |
285+
| `testRuntimeOnly` | test runtime | |

RELEASE.md

+3-11
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ projects.version=0.11.0-SNAPSHOT
1717
projects.latestVersion=0.10.5
1818
```
1919
2. Update versions in `README.md`
20-
3. Update versions in [the QuickStart section of the website](arrow-site/docs/docs/quickstart/README.md).
21-
4. Update versions in [the sidebar](arrow-site/docs/_data/doc-versions.yml).
2220

2321
When merging that pull request, these things will happen automatically:
2422

@@ -37,7 +35,7 @@ Then, close and release the Sonatype repository to sync with Maven Central:
3735
4. Select the staging repository and **Release** to sync with Maven Central
3836
5. **Drop** and repeat if there are issues.
3937

40-
NOTE: [This plugin](https://github.com/gradle-nexus/publish-plugin) provides tasks for closing and releasing the staging repositories. However, that plugin must be applied to the root project and it would be necessary to discard modules for publication. Let's keep this note here to give it a try later on.
38+
NOTE: [This plugin](https://github.com/gradle-nexus/publish-plugin) provides tasks for closing and releasing the staging repositories. However, that plugin must be applied to the root project, and it would be necessary to discard modules for publication. Let's keep this note here to give it a try later on.
4139

4240
### About signing artifacts with GPG/PGP
4341

@@ -55,22 +53,20 @@ To verify artifacts during **Close** task, the public key must be distributed to
5553
Context:
5654

5755
* Latest release has a bug and `main` branch already has other additional features.
58-
* A released version has a bug and it's not the latest release.
56+
* A released version has a bug, and it's not the latest release.
5957

6058
How to fix a `<major.minor.patch>` version in some of those contexts:
6159

6260
1. Create `release/<major.minor.(patch + 1)>` branch from tag `<major.minor.patch>`.
6361
2. Apply the fix into the new branch:
6462
* Via pull request for new changes.
6563
* Directly for existing changes (cherry-pick).
66-
3. Check that new `<major.minor.(patch + 1)-SNAPSHOT>` artifacts are deployed into [Sonatype OSSRH](https://oss.sonatype.org/service/local/repositories/snapshots/content/io/arrow-kt/) with the fixes.
64+
3. Check that new `<major.minor.(patch + 1)-SNAPSHOT>` artifacts are deployed into [Sonatype OSS](https://oss.sonatype.org/service/local/repositories/snapshots/content/io/arrow-kt/) with the fixes.
6765
4. Try the new `<major.minor.(patch + 1)-SNAPSHOT>` version.
6866
5. Create a pull request into `main` branch if the fix must be applied to the new versions as well.
6967
6. Create a pull request into `release/<major.minor.(patch + 1)>` branch to release the fix:
7068
* Change just `projects.latestVersion` in `arrow-libs/gradle.properties`.
7169
* Update the version in `README.md`.
72-
* Update the version in [the QuickStart section of the website](arrow-site/docs/docs/quickstart/README.md).
73-
* Update [the sidebar](arrow-site/docs/_data/doc-versions.yml).
7470

7571
What will happen when merging the last pull request?
7672

@@ -81,7 +77,3 @@ What will happen when merging the last pull request?
8177
TODO: Release notes and GitHub release must be created manually.
8278

8379
Then, close and release the Sonatype repository to sync with Maven Central in the same way as other versions.
84-
85-
Last step:
86-
87-
* Update [the sidebar](arrow-site/docs/_data/doc-versions.yml) in the `main` branch to show the new latest version for `major.minor`.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)