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

docs: Add verify script #3239

Merged
merged 3 commits into from
Oct 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,9 @@ Please decide how far you trust this user to correctly verify other users' keys
Your decision? 5 #choose 5
Do you really want to set this key to ultimate trust? (y/N) y #choose y
```

## Verify
Xuanwo marked this conversation as resolved.
Show resolved Hide resolved

```shell
./scripts/verify.py
```
91 changes: 91 additions & 0 deletions scripts/verify.py
Xuanwo marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
#!/usr/bin/env python3
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# 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.


import subprocess
import sys
import os

BASE_DIR = os.getcwd()


def check_rust():
try:
subprocess.run(["cargo", "--version"], check=True)
return True
except FileNotFoundError:
return False
except Exception as e:
raise Exception("Check rust met unexpected error", e)


def check_java():
try:
subprocess.run(["java", "--version"], check=True)
return True
except FileNotFoundError:
return False
except Exception as e:
raise Exception("Check java met unexpected error", e)


def build_core():
print("Start building opendal core")

subprocess.run(["cargo", "build", "--release"], check=True)


def build_java_binding():
print("Start building opendal java binding")

# change to java binding directory
os.chdir("bindings/java")

subprocess.run(
suyanhanx marked this conversation as resolved.
Show resolved Hide resolved
[
"./mvnw",
"clean",
"install",
"-DskipTests=true",
"-Dcargo-build.profile=release",
],
check=True,
)

# change back to base directory
os.chdir(BASE_DIR)


def main():
if not check_rust():
print(
"Cargo is not found, please check if rust development has been setup correctly"
)
print("Visit https://www.rust-lang.org/tools/install for more information")
sys.exit(1)

build_core()

if check_java():
build_java_binding()
else:
print("Java is not found, skipped building java binding")


if __name__ == "__main__":
main()
8 changes: 8 additions & 0 deletions website/community/committers/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,10 @@ https://github.com/apache/incubator-opendal/tree/main/scripts
To compile from source, please refer to:
https://github.com/apache/incubator-opendal/blob/main/CONTRIBUTING.md

Here is python script in release to help you verify the release candidate:

./scripts/verify.py

Thanks

${name}
Expand Down Expand Up @@ -415,6 +419,10 @@ https://github.com/apache/incubator-opendal/tree/main/scripts
To compile from source, please refer to:
https://github.com/apache/incubator-opendal/blob/main/CONTRIBUTING.md

Here is python script in release to help you verify the release candidate:

./scripts/verify.py

Thanks

${name}
Expand Down