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

run GitHub actions locally using gh act #36117

Merged
merged 6 commits into from
Sep 1, 2023
Merged

Conversation

dimpase
Copy link
Member

@dimpase dimpase commented Aug 22, 2023

document how to run GitHub actions locally using gh and docker

gh has an extension called act, which allows to run Actions locally (subject to the usual Docker restrictions, e.g. no macOS on Linux)

Still it's very useful, e.g. for debugging purposes.

@dimpase dimpase marked this pull request as draft August 22, 2023 11:36
@dimpase dimpase requested a review from kwankyu August 22, 2023 13:58
Copy link
Contributor

@tobiasdiez tobiasdiez left a comment

Choose a reason for hiding this comment

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

LGTM! Is there a reason why this is marked as draft?

@mkoeppe
Copy link
Member

mkoeppe commented Aug 22, 2023

I think the new section is misplaced here - this file has the basic steps of working with GitHub.

Perhaps move it to portability_testing.rst or tools.rst, or a new file

@dimpase
Copy link
Member Author

dimpase commented Aug 22, 2023

it's a draft cause I meant to add more details, and indeed to see where it should be. This is about working with GitHub data, and gh tool. Although the latter is not crucial, as act may be installed stand-alone and used without gh, on one hand. On the other hand it's (mostly) portability testing. How about leaving a part as it is now, and move more testing-specific part to portability_testing ?

@dimpase
Copy link
Member Author

dimpase commented Aug 23, 2023

tested with gh act -p false -r -j lint-rst - in accordance with https://en.wikipedia.org/wiki/Eating_your_own_dog_food

@dimpase dimpase marked this pull request as ready for review August 23, 2023 09:42
0 cygwin-stage-i-b cygwin-stage-i-b CI cygwin-standard ci-cygwin-standard.yml push,workflow_dispatch
[...]

run a particular action ``foobar`` ::
Copy link
Member

Choose a reason for hiding this comment

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

I think it would be better to give an example that actually exists (and ideally also include that in the above gh act -l output)

@mkoeppe
Copy link
Member

mkoeppe commented Aug 24, 2023

I think PDF docs won't build because of the emojis such as 🚀

@dimpase
Copy link
Member Author

dimpase commented Aug 25, 2023

yeah, and probably there is no TeX font to use for these. High time we switch to LuaTeX... Has anyone tried?

@dimpase
Copy link
Member Author

dimpase commented Aug 25, 2023

OK, I tested pdf docbuild, it works now

Copy link
Member

@mkoeppe mkoeppe left a comment

Choose a reason for hiding this comment

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

LGTM

@github-actions
Copy link

Documentation preview for this PR (built with commit 6a6e5ec; changes) is ready! 🎉

Copy link
Collaborator

@kwankyu kwankyu left a comment

Choose a reason for hiding this comment

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

Thanks. LGTM.

@vbraun vbraun merged commit 52c7956 into sagemath:develop Sep 1, 2023
15 of 18 checks passed
@mkoeppe mkoeppe added this to the sage-10.2 milestone Sep 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants