NEW: Migrate your CI/CD Pipelines to GitHub with GitHub Actions Importer

[a-a-ron]

Module title: Migrate your CI/CD Pipelines to GitHub with GitHub Actions Importer

Outline doc: https://docs.google.com/document/d/1PBl6nNFQV8zeSc46kH5Vl-Y-ac0Xu4glF_uVb3sE-So/edit

Helpful resources

• https://docs.github.com/en/actions/migrating-to-github-actions/automating-migration-with-github-actions-importer
• https://github.blog/2022-11-10-introducing-github-actions-importer/
• https://github.com/valet-customers/labs

Module Outline

[camihmerhar]

Howdy @ethanis!

Here is the outline for the GAI module! Would love to get your thoughts on what we have so far.

Here are a couple of questions we wanted your thoughts on as well:

• The outline currently has two content units. Does the flow of content seem right or should we create a 3rd content unit to categorize the content better?
• What are your thoughts on the learning objectives?
• What would you change or add to the outline?

Let @a-a-ron and me know if you have any questions!

---

Introduction

Learning Objectives

• Review how to install the GitHub Actions Importer CLI Extension, ensure it's up-to-date, and learn about supported CI platforms
• Comprehend how to execute the audit, forecast, dry-run, and migrate commands and learn what is not automatically migrated

Prerequisites

• You must have been granted access to the public preview for the GitHub Actions Importer
• You must have credentials to authenticate to the GitHub Packages Container registry. For more information, see "Working with the Container registry"
• An environment where you can run Linux-based containers, and can install the necessary tools
  • Docker is installed and running
  • GitHub CLI is installed

Unit 1 - How to install GitHub Actions Importer CLI Extension and ensure its up-to-date

• How to install GitHub Actions Importer CLI extension
• Updating the GitHub Actions Importer CLI
• Authenticating at the command line
• GitHub Actions Importer CI supported platforms

Unit 2 - How to execute GitHub Actions Importer commands and what is not automatically migrated

• How to audit your pipelines
• How to run the forecast command
• How to run a dry-run migration
• How to execute your migration
• What is not automatically migrated

Exercise

• GitHub Actions migrations powered by Valet
  • Allowing learner to choose their learning plath based on their CI pipelines

Knowledge Check

Questions focused on the content we went over in the module

Summary

Quick review of what we learned in the module

More information on GAI:

• Automating migration with GitHub Actions Importer
• Introducing GitHub Actions Importer

[JenniferKerns]

Hello @camihmerhar! I have a few pieces of preliminary feedback to share:

• The link to the content for unit 2 actually links to unit 1
• Our Field Engineering style guide (WiP!) includes some style decisions specific to GitHub Actions Importer. I'm happy to respond to any queries you might have about naming, language, etc.
• The correct source for our labs repo is: https://github.com/actions/importer-labs
• We need to keep a watchful eye out for any residual references to the code name Valet
• I would probably rename the units. (something like: Unit 1 - How to install, update, and configure GitHub Actions Importer; Unit 2 - How to run GitHub Actions Importer commands/Unit 2 - How to use GitHub Actions Importer)

question: Do you want me to read through the draft content?

[camihmerhar]

Hello @camihmerhar! I have a few pieces of preliminary feedback to share:

• The link to the content for unit 2 actually links to unit 1
• Our Field Engineering style guide (WiP!) includes some style decisions specific to GitHub Actions Importer. I'm happy to respond to any queries you might have about naming, language, etc.
• The correct source for our labs repo is: https://github.com/actions/importer-labs
• We need to keep a watchful eye out for any residual references to the code name Valet
• I would probably rename the units. (something like: Unit 1 - How to install, update, and configure GitHub Actions Importer; Unit 2 - How to run GitHub Actions Importer commands/Unit 2 - How to use GitHub Actions Importer)

question: Do you want me to read through the draft content?

Howdy @JenniferKerns!

• Thanks for the feedback and I'm embarrassed about that missed link 😳but happy you called it out so I can fix it.🤗
• I will review the Field Engineering style guide and let you know if I have any question in regards to nomenclature specific to GitHub Actions Importer.
• I'll updated the labs repo link with the one you provided.
• Will definitely make sure to keep tabs on the code name Valet prior to publishing the module.
• And will also update the unit names based on your feedback

I would love your feedback on the drafted content, but only if you have time. I've pulled the majority of the content from the blog post you and Ethan wrote, so it would be great to know if I utilized anything out of context.

[rmallorybpc]

Hey @camihmerhar please let me know if you have any questions. - Ross

2-How-to-install,-update,-and-configure-GitHub-Actions-Importer.md I may break up the intro sentence, below or similar. Before we get into learning about the different commands you can run in GitHub Actions Importer. First, we'll review installation to ensure you have the most up-to-date version. Then we will learn about the supported CI platforms.

3-How-run-GitHub-Actions-Importer-commands.md "Forcast" to "Forecast" in the first bullets. Add a space after the comma in, "for example,build tasks or build triggers" "How to run the forecast commmand", change to, "command" "isLiteral: true", change to, "isLiteral" In "Once you initiate the command it will provide an Audit Summary report" and "Let’s go over the details the Audit Summary report will provide you, make "summary" lowercase Add a space after the comma, "(for example,build tasks or build triggers)" "When you are defining an organization-level allowlist", change to "allow list" "In the next section we’ll be going over the" and "In this section we’ll be reviewing how to run the" maybe add a comment after "section". There are some other section intros that could include the comma as well. Does "migrate" need to be formatted as code, "You can use the migrate command"? Do we want to link out from this unit in, "For specific differences for supported CI platforms please reference the following links"

[rmallorybpc]

@camihmerhar here is my latest review. Please let me know if there are any questions.

1-introduction.md

• [x] that won't be autmatically migrated when - update "automatically"
• [x] Do you want to mention the exercise options in the Learning Objectives (LO)? Connecting the LO and Prerequisites. Idea below.
• [x] Run through a mock migration lab exercise for a supported CI platform with the platforms mentioned below
• [x] I am not sure the content below the Prerequisites is part of the prerequisites. Starting with, As you'll learn from this module. This seems more about what the learner will get from the module. Then the transition sentence will remain as the final sentence.~~

2-How-to-install,-update,-and-configure-GitHub-Actions-Importer.md

• let's first review installating GitHub Actions Importer - update "installing"
• [x] I am reading the intro to the unit as repetitive. I think we can rephrase the opening to the below. Then the bullets and restating where we are started are not needed. Up to you of course.
• First we will review installating GitHub Actions Importer and ensuring you have the most up-to-date version. In the next unit, we will dive into the four commands you can run in GitHub Actions Importer. Let's start with how to install GitHub Actions Importer CLI extension

3-How-run-GitHub-Actions-Importer-commands.md

• [x] Next up, we'll be tackling how to migrate your environmment - update "environment"
• In this section, In this unit we will be walking through the following:, we will need to ensure that the branch gets updated when we publish the content. The "main" branch will need to be included for the link to work when the module goes public. This is for the "what is the audit command" and similar links within the module.

[a-a-ron]

Hey @camihmerhar. After our 1:1 today and taking some time to review the module, I have some thoughts that I'll address by each file.

2-How-to-install,-update,-and-configure-GitHub-Actions-Importer.md

(We need to remove the commas in the file name)

As we discussed, I agree that the current install/update information is redundant since we cover it at the beginning of each available lab. I propose that we remove this information and repurpose this unit to better explain and introduce GAI. For example, in the introduction unit, we say that GAI is designed to help you forecast, plan, and facilitate migrations to GitHub Actions but we then move right into steps to install it and then move right into the 4 commands (audit, forecast, dry-run, and migrate). I feel like we are missing the connection between the initial introduction with the learning objectives and the 4 commands that will be used.

What are your thoughts on removing the install/update content and add some content to introduce each section that GAI is designed to help you with (forecast, plan, and facilitate). We can use this unit to provide a high-level overview of why these phases are important or needed and the transition to the 4 commands that are relevant to these areas. I think it will flow better. I don't want to copy/paste content from the blog post but If we could summarize that content into this unit before introducing the 4 commands then I think that would help fill this gap.

3-How-run-GitHub-Actions-Importer-commands.md

This unit looks pretty good. I would remove the entire links section at the top (lines 14-19). We introduce these commands at the top so I think this is redundant and I don't want the learner to jump around. I like that we continue to talk about the lab at the beginning of the unit, but I don't want to link to the lab right now. That will prompt the learner to leave the module before we discuss the content in the unit.

5-exercise.md

Can we reformat this unit to match our other exercise units? We can just link out to the lab instead of providing the learning lab section that is included in the importer-labs repo. Here's an example of an exercise file. We just need to edit the content to introduce these specific labs and then change the link.