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

Migrating to the new Workbench format #1297

Open
deppen8 opened this issue May 5, 2022 · 30 comments
Open

Migrating to the new Workbench format #1297

deppen8 opened this issue May 5, 2022 · 30 comments

Comments

@deppen8
Copy link
Contributor

deppen8 commented May 5, 2022

@swcarpentry/shell-novice-maintainers , this issue is to discuss whether we want to sign up for the Workbench beta (https://carpentries.org/blog/2022/05/workbench-beta/).

I'm interested in being an early adopter, but I think we should have a consensus before we make the leap.

@bkmgit
Copy link
Contributor

bkmgit commented Aug 16, 2022

@deppen8 Interested in trying this.

@deppen8
Copy link
Contributor Author

deppen8 commented Aug 16, 2022

@gcapes , how do you feel about stepping out onto the cutting edge?

@bkmgit
Copy link
Contributor

bkmgit commented Apr 11, 2023

@gcapes @deppen8 We need to close out all pull requests for migration. Is doing this by 17 April 2023 feasible?

@gcapes
Copy link
Contributor

gcapes commented Apr 11, 2023

I thought they need to be closed by the end of April? I'll try to get some done this week.

@bkmgit
Copy link
Contributor

bkmgit commented Apr 19, 2023

@deppen8
Copy link
Contributor Author

deppen8 commented Apr 19, 2023

I'm totally fine with you exercising your maintainer judgement on whether to merge/close these last few.

@bkmgit
Copy link
Contributor

bkmgit commented Apr 20, 2023

@zkamvar @gcapes @deppen8 Will transition this lesson over the next few days. All pull requests have been closed.

@zkamvar
Copy link
Contributor

zkamvar commented Apr 24, 2023

Hello! We just saw this. It was not previously on my radar for early transition because of the number of commits, but we tentatively have room on the 26th if that works for you. I need to do a little bit more testing for this lesson. I'm tracking issues here and it seems to be ready, but I need to dig a little deeper to make sure nothing is out of the blue carpentries/lesson-transition#80

@tobyhodges is creating a PR for the lesson release right now.

@bkmgit
Copy link
Contributor

bkmgit commented Apr 24, 2023 via email

@zkamvar
Copy link
Contributor

zkamvar commented Apr 24, 2023

Thanks. Assumed we could use your transition tool. It seems to be well documented, but need to do a test first. However, it is also ok if you will do the migration

Please do not do the transtion yourselves. The transition process requires admin access to the repository, but I do not know the consequences of using it with only write access. The plan for this has always been that this would be my responsibility to coordinate and execute. The responsibility of the maintainers is to the lesson content.

@zkamvar
Copy link
Contributor

zkamvar commented Apr 24, 2023

I would also like to stress that there is no guarantee that we will be able to hit the April 26th target.

This lesson is used by the vast majority of Carpentries workshops and it is important to take care during its transition to make sure elements are all there.

This is an example of what the lesson looks like after transition without customisation: https://fishtree-attempt.github.io/shell-novice/ (I would give you an updated version, but GitHub is experiencing issues right now)

The transition workflow mostly works, but there are instances where formatting peculiarlities in kramdown are not parseable by my translator (e.g. HTML tags that are not separated from markdown by whitespace).

@zkamvar
Copy link
Contributor

zkamvar commented Apr 25, 2023

Hello,

I apologise, but after some thought, I will need a few more days to make sure the transition of this lesson is all correct, so I have re-instated the May 1 transition date.

@zkamvar
Copy link
Contributor

zkamvar commented May 1, 2023

We will be transitioning this lesson tomorrow. I have fixed all the issues that were identified and you can see the preview here: https://fishtree-attempt.github.io/shell-novice/

@zkamvar
Copy link
Contributor

zkamvar commented May 2, 2023

This lesson will be converted to use The Carpentries Workbench
To prevent accidental reversion of the changes, we are temporarily revoking
write access for all collaborators on this lesson:

If you no longer wish to have write access to this repository, you do not
need to do anything further.

  1. What you can expect from the transition 📹: https://carpentries.github.io/workbench/beta-phase.html#beta
  2. How to update your local clone 💻: https://carpentries.github.io/workbench/beta-phase.html#updating-clone
  3. How to update (delete) your fork (if you have one) 📹: https://carpentries.github.io/workbench/faq.html#update-fork-from-styles

If you wish to regain write access, please re-clone the repository on your machine and
then comment here with I am ready for write access :rocket: and the
admin maintainer of this repository will restore your permissions.

If you have any questions, please reply here and tag @zkamvar

@zkamvar
Copy link
Contributor

zkamvar commented May 2, 2023

The deed is done. The infrastructure takes a few minutes to bootstrap and cache the packages for the lesson build. Once the build is done, I will switch github pages to deploy from the gh-pages branch and you will have your workbench lesson.

Thank you all for your enthusiasm and your patience!

@zkamvar
Copy link
Contributor

zkamvar commented May 2, 2023

The Workbench version is now live: https://swcarpentry.github.io/shell-novice/

In addition, here is map of commits that were changed during the transition

@bkmgit
Copy link
Contributor

bkmgit commented May 2, 2023

I am ready for write access 🚀

@zkamvar
Copy link
Contributor

zkamvar commented May 2, 2023

@bkmgit you now have write access 🎉

@gcapes
Copy link
Contributor

gcapes commented May 3, 2023

I am ready for write access 🚀

Can we set this repo up so that we can merge feature branches locally and push to main without having to go through a PR? What do you think @deppen8 @bkmgit ?

@bkmgit
Copy link
Contributor

bkmgit commented May 3, 2023

@gcapes Merging feature branches locally is fine for me, though the PR review process is helpful for all but minor changes. Expect most contributions will come from forks, so will still need to use PRs.

@gcapes
Copy link
Contributor

gcapes commented May 3, 2023

Sure, PRs are useful, but sometimes there's a little extra that needs doing before you want to merge them (and the contributor has gone quiet). It's this kind of 'tidying up' where fetching the PR branch, adding commits locally, then merging is a useful workflow (for me at least).

@deppen8
Copy link
Contributor Author

deppen8 commented May 3, 2023

Sure, PRs are useful, but sometimes there's a little extra that needs doing before you want to merge them (and the contributor has gone quiet). It's this kind of 'tidying up' where fetching the PR branch, adding commits locally, then merging is a useful workflow (for me at least).

Not sure if this is a permission that can we can set ourselves. I think we need contributors to check the "Allow edits from maintainers" box.
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork

If that is true, I think the best thing we can do is update the contribution guidelines. Secondarily, we might also be able to set up a bot to check for that whenever we get a PR; if it isn't enabled, it asks the contributor to do so.

@gcapes
Copy link
Contributor

gcapes commented May 3, 2023

It's not. It's something that @zkamvar can set though :)

Updating the contributing guidelines is also a good idea, but the use-case I'm keen to keep is where you get a PR which is nearly there, but the contributor goes quiet and it's easiest to just finish the PR yourself. If they've not allowed edits from maintainers, there's not much you can do in this situation other than finish the PR and merge locally.

@zkamvar
Copy link
Contributor

zkamvar commented May 3, 2023

@gcapes you now have write access!

@zkamvar
Copy link
Contributor

zkamvar commented May 3, 2023

For additional clarity WRT to the protection of the default branch, see swcarpentry/make-novice#169 (comment)

@bkmgit
Copy link
Contributor

bkmgit commented May 3, 2023

Ok to lift restrictions on main for me.

@deppen8
Copy link
Contributor Author

deppen8 commented May 16, 2023

I am ready for write access 🚀

@zkamvar
Copy link
Contributor

zkamvar commented May 16, 2023

@deppen8 access granted! All maintainers on this lesson now have write access!

@deppen8
Copy link
Contributor Author

deppen8 commented May 16, 2023

@bkmgit @gcapes , we OK to close this now? Give me a 👍 or 👎 on this comment.

@gcapes
Copy link
Contributor

gcapes commented May 17, 2023

Do you have push access yet @deppen8 ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants