Skip to content

Add cargo make tasks for packaging/publishing #143

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 22, 2020
Merged

Add cargo make tasks for packaging/publishing #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d4a844
Add cargo make tasks for packaging/publishing
russcam Sep 21, 2020
7e4dc26
Simplify tasks
russcam Sep 22, 2020
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
74 changes: 72 additions & 2 deletions Makefile.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ default_to_workspace = false
STACK_VERSION = "8.0.0-SNAPSHOT"
# Determines the distribution of docker container used. Either xpack or oss
TEST_SUITE = "xpack"
# Set publish flags to dry-run by default, to force user to explicitly define for publishing
CARGO_MAKE_CARGO_PUBLISH_FLAGS = "--dry-run"

[tasks.set-oss-env]
category = "Elasticsearch"
Expand Down Expand Up @@ -81,6 +83,19 @@ condition = { env_set = [ "CI" ] }
script = ["cat test_results/results.json | cargo2junit > test_results/cargo-junit.xml"]
dependencies = ["install-cargo2junit"]

[tasks.publish-elasticsearch]
description = "Runs the cargo publish command."
category = "Elasticsearch"
private = true
script_runner = "@duckscript"
script = [
"""
cd elasticsearch
echo "publishing elasticsearch crate: cargo publish %{CARGO_MAKE_CARGO_PUBLISH_FLAGS}"
exec cargo publish %{CARGO_MAKE_CARGO_PUBLISH_FLAGS}
"""
]

# ============
# Public tasks
# ============
Expand Down Expand Up @@ -139,6 +154,46 @@ description = "Generates Elasticsearch client from REST API specs"
dependencies = ["run-api-generator"]
run_task = "format"

[tasks.docs]
description = "Generate Elasticsearch client documentation and opens in browser"
clear = true
category = "Elasticsearch"
command = "cargo"
args = ["doc", "-p", "elasticsearch", "--no-deps", "--open"]

[tasks.generate-release-notes]
category = "Elasticsearch"
description = """
Generates release notes for Elasticsearch client using a common release notes generator docker image.
Assumes the clients-team repo is checked out as a sibling directory of elasticsearch-rs
"""
condition = { env_set = ["OLD_VERSION", "NEW_VERSION"], files_exist = [ "${CARGO_MAKE_WORKING_DIRECTORY}/../clients-team/scripts/release-notes-generator/Dockerfile" ] }
script_runner = "@shell"
script = [
"""
cd ./../clients-team/scripts/release-notes-generator
docker build --file ./Dockerfile --tag clients-team/release_notes_generator .
docker run -v "${CARGO_MAKE_WORKING_DIRECTORY}/.ci/release/config.yml:/usr/src/release_notes_generator/config.yml" --rm clients-team/release_notes_generator -o ${OLD_VERSION} -n ${NEW_VERSION}
"""
]

[tasks.publish]
clear = true
dependencies = [ "publish-elasticsearch" ]
run_task = "generate-release-notes"

[tasks.package]
clear = true
description = "Runs the cargo package command for elasticsearch crate."
category = "Elasticsearch"
script_runner = "@duckscript"
script = [
"""
cd elasticsearch
echo "packaging elasticsearch crate: cargo package %{CARGO_MAKE_CARGO_PACKAGE_FLAGS}"
cargo package %{CARGO_MAKE_CARGO_PACKAGE_FLAGS}
"""
]

[tasks.default]
clear = true
Expand All @@ -148,10 +203,18 @@ script = ['''
echo "- generate-api: Generates Elasticsearch client from REST API specs"
echo "- start-elasticsearch: Starts Elasticsearch docker container with the given version and distribution"
echo "- stop-elasticsearch: Stops Elasticsearch docker container, if running"
echo
echo "- test-yaml: Generates and runs yaml_test_runner package xpack/oss tests against a given Elasticsearch version"
echo "- test-generator: Generates and runs api_generator package tests"
echo "- test: Runs elasticsearch package tests against a given Elasticsearch version"
echo
echo "- generate-release-notes: Generates release notes for elasticsearch crate."
echo " pass OLD_VERSION and NEW_VERSION environment variables to match release version GitHub labels e.g. v7.9.0-alpha.1"
echo "- package: Packages the elasticsearch crate."
echo " package flags can be overridden with CARGO_MAKE_CARGO_PACKAGE_FLAGS environment variable"
echo "- publish: Publishes the elasticsearch crate."
echo " By default, peforms a dry run by passing --dry-run, but publish flags can be overridden with CARGO_MAKE_CARGO_PUBLISH_FLAGS environment variable"
echo
echo "Most tasks use these environment variables:"
echo "- STACK_VERSION (default '$STACK_VERSION'): the version of Elasticsearch"
echo "- TEST_SUITE ('oss' or 'xpack', default '$TEST_SUITE'): the distribution of Elasticsearch"
Expand All @@ -173,9 +236,16 @@ script = ['''
echo - test-generator: Generates and runs api_generator package tests
echo - test: Runs elasticsearch package tests against a given Elasticsearch version
echo.
echo - generate-release-notes: Generates release notes for elasticsearch crate
echo pass OLD_VERSION and NEW_VERSION environment variables to match release version GitHub labels e.g. v7.9.0-alpha.1
echo - package: Packages the elasticsearch crate.
echo package flags can be overridden with CARGO_MAKE_CARGO_PACKAGE_FLAGS environment variable
echo - publish: Publishes the elasticsearch crate.
echo By default, peforms a dry run by passing --dry-run, but publish flags can be overridden with CARGO_MAKE_CARGO_PUBLISH_FLAGS environment variable
echo.
echo Most tasks use these environment variables:
echo - STACK_VERSION (default '$STACK_VERSION'): the version of Elasticsearch
echo - TEST_SUITE ('oss' or 'xpack', default '$TEST_SUITE'): the distribution of Elasticsearch
echo - STACK_VERSION (default '%STACK_VERSION%'): the version of Elasticsearch
echo - TEST_SUITE ('oss' or 'xpack', default '%TEST_SUITE%'): the distribution of Elasticsearch
echo - CI (default not set): set when running on CI to determine whether to start Elasticsearch and format test output as JSON
echo.
echo Run 'cargo make --list-all-steps' for a complete list of available tasks.
Expand Down
3 changes: 2 additions & 1 deletion api_generator/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
[package]
name = "api_generator"
version = "8.0.0-alpha.1"
publish = false
description = "Generates source code for elasticsearch package, from the Elasticsearch REST API specs"
repository = "https://github.com/elastic/elasticsearch-rs"
authors = ["Elastic and Contributors"]
edition = "2018"
license = "Apache-2.0"
publish = false

[dependencies]
array_tool = "1.0.3"
Expand Down
2 changes: 2 additions & 0 deletions yaml_test_runner/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
[package]
name = "yaml_test_runner"
version = "8.0.0-alpha.1"
publish = false
edition = "2018"
authors = ["Elastic and Contributors"]
description = "Generates and runs tests from Elasticsearch's YAML test specs"
repository = "https://github.com/elastic/elasticsearch-rs"
license = "Apache-2.0"

[dependencies]
elasticsearch = { path = "./../elasticsearch" }
Expand Down