Your first JavaScript action

Question

Your first JavaScript action

github-learning-lab opened this issue 3 years ago · comments

github-learning-lab commented 3 years ago

On to your development environment

@ShantnuS our JavaScript actions are going to leverage the GitHub ToolKit for developing GitHub Actions.

This is an external library that we will install using npm which means that you will need Node.js installed.

I find writing actions to be easier from a local environment vs trying to do everything right here in the repository. Doing these steps locally allows you to use the editor of your choice so that you have all the extensions and snippets you are used to when writing code.

If you do not have a preferred environment then I suggest following along with me exactly as you see on the screen, which means you'll need to install Visual Studio Code.

Don't forget to set up your workstation 😉

Most of your work going forward will take place away from your Learning Lab repository, so before continuing with the course ensure you have the following installed on your local machine.

Node.js
Visual Studio Code or your editor of choice
Git

⌨️ Activity: Initialize a new JavaScript project

Once you have the necessary tools installed locally, follow these steps to begin creating your first action.

Open the Terminal (Mac and Linux) or Command Prompt (Windows) on your local machine

Clone your Learning Lab repo to your local machine:

git clone https://github.com/ShantnuS/writing-javascript-actions.git

Navigate to the folder you just cloned:
```
cd writing-javascript-actions
```
Create a new branch named hello-world. This is the branch we will use to write our first action. Please do not capitalize letters unless I do, I run case-sensitive checks to make sure I can help you along the way!
```
git checkout -b hello-world
```
Create a new folder for our actions files:
```
mkdir -p .github/actions/hello-world
```
Navigate to the hello-world folder you just created:
```
cd .github/actions/hello-world
```
Initialize a new project:
```
npm init -y
```
Install the core dependency from the GitHub ToolKit:
```
npm install --save @actions/core
```
Commit those newly added files,we will remove the need to upload node_modules in a later step:
```
git add .
git commit -m 'add project dependencies'
```
Push your changes to your repository:
```
git push -u origin hello-world
```

I will respond once you have finished.

github-learning-lab · Answer 1 · Wed Dec 08 2021 22:06:49 GMT+0800 (China Standard Time)

Please ensure that on your hello-world branch, you've taken the following steps:

# 1. Created a folder with the name: .github/actions/hello-world
mkdir -p .github/actions/hello-world
cd .github/actions/hello-world

# 2. Inside the new folder, initialized it as a Node.js project:
npm init -y

# 3. Installed the core dependency from the GitHub Actions Toolkit:
npm install --save @actions/core

# 4. Staged, committed, and pushed all the files that were generated as a result:
git add .
git commit -m 'initial hello-world'
git push -u origin hello-world

This will generate a number of files, but I'm spot checking that:

the following file exists: .github/actions/hello-world/package.json
that it contains the core dependency from the GitHub Actions Toolkit (note: I'm not paying attention to the version number):
```
"dependencies": {
  "@actions/core": "^1.2.1"
}
```

github-learning-lab · Answer 2 · Wed Dec 08 2021 22:08:14 GMT+0800 (China Standard Time)

Great job 👍

I have created a new pull request where we will continue this lesson. Click the link to meet me over there.

In the meantime I have closed this issue since we wont be needing it anymore 😄