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.

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

Jump to bottom

Add CI to publish builtin plugins #1648

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
+63 −0
Open

Add CI to publish builtin plugins #1648

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
29daaac
Add `get_cairo_version` xtask
DelevoXDG Oct 15, 2024
eebc8ea
Add initial publish workflow
DelevoXDG Oct 15, 2024
57a424d
Revert "Add `get_cairo_version` xtask"
DelevoXDG Oct 15, 2024
e8171fe
Update workflow: Publish from cache; Refactor
DelevoXDG Oct 15, 2024
98cdaf7
Skip if already exists; Publish plugins explicitly
DelevoXDG Oct 16, 2024
084a39c
Fix `cairo_test` url
DelevoXDG Oct 16, 2024
cf5ecf6
Use pushd
DelevoXDG Oct 16, 2024
601aaef
Remove unnecessary `popd`s
DelevoXDG Oct 16, 2024
b9167c2
Add missing newline
DelevoXDG Oct 16, 2024
5b53314
Merge https://github.com/software-mansion/scarb into zdobnikau/publis…
DelevoXDG Oct 18, 2024
5277552
Remove `--no-verify`
DelevoXDG Oct 18, 2024
b0826b7
Update cache path resolution
DelevoXDG Oct 18, 2024
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
63 changes: 63 additions & 0 deletions .github/workflows/publish_plugins.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Publish Built-in Plugins
on:
release:
types:
- published

jobs:
publish:
name: Publish plugins
runs-on: ubuntu-latest
env:
SCARB_REGISTRY_AUTH_TOKEN: ${{ secrets.SCARB_REGISTRY_AUTH_TOKEN }}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

What token do you think we should keep in our GitHub secrets? Do we want to use some sort of an organization account, or will my personal token do for now? :D

Also, do you think we need any expiration date for it?

Copy link
Contributor

Choose a reason for hiding this comment

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

Your personal will do. One year rotation seems alright.


steps:
- uses: actions/checkout@v4

- uses: software-mansion/setup-scarb@v1
with:
scarb-version: ${{ github.ref_name }}
Copy link
Contributor

Choose a reason for hiding this comment

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

Won't this be refs/tags/<tag_name>? https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#release

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Afaik, ref_name is a short name and is not the same as GITHUB_REF.

ref_name should be a name of the tag that triggered the workflow: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#github-context


- name: Init Scarb to cache plugins
id: scarb-init
run: |
set -eo pipefail
mkdir -p $HOME/pkg
pushd $HOME/pkg
scarb init --no-vcs
echo "CAIRO_VERSION=$(scarb metadata --format-version 1 | jq -r '.app_version_info.cairo.version')" >> $GITHUB_OUTPUT
env:
SCARB_INIT_TEST_RUNNER: cairo-test

- name: Check if plugin versions exist in the registry
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need to check it here? Can't we just try to publish and let the pipeline fail if it has already been uploaded? (Generally it expect it not to be, right?)

Copy link
Contributor Author

@DelevoXDG DelevoXDG Oct 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

(Generally it expect it not to be, right?)

Since some Cairo versions correspond to multiple Scarb versions, this is likely to happen from time to time.

Can't we just try to publish and let the pipeline fail if it has already been uploaded?

I think this is the question of deciding how do we want the action to resolve in such instances. We can continue-on-error, and let entire workflow fail, or we can skip the uploads. It seems to me that if action is resolved with a result that is within what is expected should not be deemed "failed".

id: check-plugins
run: |
set -eo pipefail
echo "assert_macros_exists=$(curl -s https://scarbs.xyz/api/v1/index/as/se/assert_macros.json | jq --arg version "${{ steps.scarb-init.outputs.CAIRO_VERSION }}" '[.[] | select(.v == $version)] | length > 0')" >> $GITHUB_OUTPUT
echo "cairo_run_exists=$(curl -s https://scarbs.xyz/api/v1/index/ca/ir/cairo_run.json | jq --arg version "${{ steps.scarb-init.outputs.CAIRO_VERSION }}" '[.[] | select(.v == $version)] | length > 0')" >> $GITHUB_OUTPUT
echo "starknet_exists=$(curl -s https://scarbs.xyz/api/v1/index/st/ar/starknet.json | jq --arg version "${{ steps.scarb-init.outputs.CAIRO_VERSION }}" '[.[] | select(.v == $version)] | length > 0')" >> $GITHUB_OUTPUT
echo "cairo_test_exists=$(curl -s https://scarbs.xyz/api/v1/index/ca/ir/cairo_test.json | jq --arg version "${{ steps.scarb-init.outputs.CAIRO_VERSION }}" '[.[] | select(.v == $version)] | length > 0')" >> $GITHUB_OUTPUT

- name: Publish starknet
if: steps.check-plugins.outputs.starknet_exists != 'true'
run: |
pushd $(scarb cache path)/registry/std/v${{ steps.scarb-init.outputs.CAIRO_VERSION }}/starknet
scarb publish

- name: Publish cairo_run
if: steps.check-plugins.outputs.cairo_run_exists != 'true'
run: |
pushd $(scarb cache path)/registry/std/v${{ steps.scarb-init.outputs.CAIRO_VERSION }}/cairo_run
scarb publish

- name: Publish cairo_test
if: steps.check-plugins.outputs.cairo_test_exists != 'true'
run: |
pushd $(scarb cache path)/registry/std/v${{ steps.scarb-init.outputs.CAIRO_VERSION }}/test_plugin
scarb publish

- name: Publish assert_macros
if: steps.check-plugins.outputs.assert_macros_exists != 'true'
run: |
pushd $(scarb cache path)/registry/std/v${{ steps.scarb-init.outputs.CAIRO_VERSION }}/assert_macros
scarb publish
Loading