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

ENH - Generalise action #34

Merged
merged 20 commits into from
Jul 12, 2023
Merged

ENH - Generalise action #34

merged 20 commits into from
Jul 12, 2023

Conversation

trallard
Copy link
Member

Right now, we can build JupyterLab and build and link lumino (hardcoded on the action workflow). Since we want to enable the testing with libraries other than lumino (e.g. notebook, accessible themes) we need to update the action to be more generalisable.

This PR should enable the generalisation of packages or tools linked to JupyterLab and some minor updates:

  • Parse package.json of the package to be linked for build and setup steps
  • Improvements to actions summary (content and format)
  • More comments in the action files

@trallard trallard marked this pull request as ready for review July 11, 2023 17:30
@trallard
Copy link
Member Author

Aha! I finally managed to solve the damn yarn and linking issues! and we should not be constrained to lumino linking only

@trallard trallard changed the title WIP - Generalise action ENH - Generalise action Jul 11, 2023
Copy link
Contributor

@gabalafou gabalafou left a comment

Choose a reason for hiding this comment

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

This is awesome, can't wait to try it out.

The code + doc changes make sense to me. Not sure how to test any of this, though.

.github/actions/link-package/action.yml Show resolved Hide resolved
Co-authored-by: gabalafou <gabriel@fouasnon.com>
@gabalafou
Copy link
Contributor

gabalafou commented Jul 12, 2023

Just a note. I noticed that the link external package action still has wording that implies that it's meant to be used for Lumino, even though the intent of the PR is to generalize beyond Lumino

@trallard
Copy link
Member Author

Thanks @gabalafou. I just pushed two commits:

  1. Better formatting the actions docs (I think a table is easier to follow)
  2. Remove any hard references to lumino (left examples in the form of jupyterlab/lumino but that should be ok)

Test-wise, I have been triggering the action manually on this branch with different refs and all seems ok, I think that is for now the best way to test the actions/workflow (see https://github.com/Quansight-Labs/jupyter-a11y-testing/actions/runs/5531119468)

@trallard
Copy link
Member Author

Will merge now!

@trallard trallard merged commit b748a27 into main Jul 12, 2023
2 checks passed
@trallard trallard deleted the trallard/generalise-action branch July 12, 2023 12:09
gabalafou added a commit that referenced this pull request Aug 1, 2023
* 🔧 Get name from package

* 🔧 Update pre-commits

* ✏️ Remove new line

* ♻️ Jupyterlab is now on main

* 👷 Fix branch in actions

* ⏪ Revert changes - we want to use yarn to link package

* 👷 Minor enhancements to action summary

* 🐛 Pass the path to the linked package

* 🔧 Update external package path

* ♻️ Move linked package summary to action

* Move working directory to top of step

* 📝 Update readmes

* 🐛 Capture path instead

* 🔧 Use vanilla jq for name

* 👷 Use yarn 3 syntax

* Should only link once

* Docs improvements

* Update .github/actions/link-package/action.yml

Co-authored-by: gabalafou <gabriel@fouasnon.com>

* Better format inputs docs

* 📝 Remove hard references to Lumino

---------

Co-authored-by: gabalafou <gabriel@fouasnon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done 💪🏾
Development

Successfully merging this pull request may close these issues.

2 participants