Skip to content

Commit

Permalink
CI add 1.10 to matrix; docs fix @ref PrefectAPI
Browse files Browse the repository at this point in the history
  • Loading branch information
mahiki committed Feb 7, 2024
1 parent b55d918 commit 132a226
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ jobs:
- '1.7'
- '1.8'
- '1.9'
- '1.10'
os:
- ubuntu-latest
- macOS-latest
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Included in the package is a bootstrapped installation of a local Prefect instan

## Installation
!!! note "Requires a Prefect Instance"
To use most functionality, a Prefect server/cloud instance must be available. Provide the API endpoint via environment variable `PREFECT_API_URL` or set the definition within julia application code. If authenticating to Prefect Cloud, or if your server instances has an authentication key, you will also need `PREFECT_API_KEY`. See [PrefectAPI](@ref).
To use most functionality, a Prefect server/cloud instance must be available. Provide the API endpoint via environment variable `PREFECT_API_URL` or set the definition within julia application code. If authenticating to Prefect Cloud, or if your server instances has an authentication key, you will also need `PREFECT_API_KEY`. See [`PrefectAPI`](@ref).

See [Prefect Installation](@ref) to quickly launch a local Prefect server.

Expand Down

4 comments on commit 132a226

@mahiki
Copy link
Owner Author

@mahiki mahiki commented on 132a226 Feb 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/100441

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.3.0 -m "<description of version>" 132a2261c815c0151a383a8dab2619cadd7c5e0d
git push origin v0.3.0

@mahiki
Copy link
Owner Author

@mahiki mahiki commented on 132a226 Feb 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

S3 read/write

  • Added read_path, write_path type function to S3BucketBlock.
  • This uses existing PrefectAPI() access to service API URL
  • AWS S3 credentials are needed, these are normally stored in the Prefect Block on the server.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/100441

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.3.0 -m "<description of version>" 132a2261c815c0151a383a8dab2619cadd7c5e0d
git push origin v0.3.0

Please sign in to comment.