DEV Community: ShulyAvraham

OSDC LESSON 8: Webhooks, git stash, tests coverage report

ShulyAvraham — Sun, 12 Mar 2023 15:30:50 +0000

GitHub

Webhooks

Found on the left bar on github website.

Define an event (e.g. push) that triggers a call to a website that I created. The event will call the website and send a json file with information from github. Then this website will receive the json file from github and perform things e.g. git pull and then generate pages from the files...

git stash

Take the local changes, keep them aside, and return to the latest committed version.

git stash

The changes were not lost.

Now I can

git pull

Bring my changes back from stash to my working directory.

git stash pop

The stash is a stack that keeps several changes. To see all changes:

git stash list

To see the most recent change in the stash

git stash show -p

To see a change in a specific stash in the stack

git stash show 1

Remove the most recent change from stash

git stash drop

Remove a specific change from the stash

git stash drop 1

Stash pop might also cause a merge conflict which needs to be resolved. In that case, the change will not be removed from the stash.

Docker playground

https://github.com/szabgab/playground

We can use @szabgab docker as playground

alias dr='docker run -it --rm --workdir /opt -v$(pwd):/opt szabgab/playground:latest bash'
dr

dr

Run an image

docker run imagename:version

If the image does not exist locally it will be downbloaded first from docker hub and then run.

Build a docker from a Docker file

docker build -t username/dockername:version

Run a project from git inside docker

Use @szabgab playground docker

dr

Or use some other docker image

docker run -it --rm --workdir /opt -v$(pwd):/opt python:3.11 bash

To explore the project we can look at the github folder, and we might find the ci tests.

make and Makefile

Run shell commands with dependencies
Instead of README.md - the Makefile contains all the commands to be run, and executing make will run these commands.
make is the command and Makefile is a file that contains commands. Each set of commands have some tag. So one might run the specific set of commands in a tag

make sometag

Example for the Makefile

init:
    pip install -r requirements.txt
ci:
    pytest tests

So to run the ci

make ci

tox

a tool to run tests on several versions of python

Coverage report for tests

First install

pip install pytest pytest-random-order pytest-coverage

pytest -svv --random-order --cov-branch cov-report html cov-report  term cov somedir......

random-order runs functions on random order to make sure functions are not dependent on each other

cov-report html will generate the report in html format

cov-report term will send the report to the terminal

cov-branch Branch coverage
In case we have an if command in the code, or loop or something along these lines, it means that depending on the data transferred to the function the code inside the if or loop might be executed or not. So the cov-branch will report in case we have several "branches" in the code, and the coverage for all branches.

contribute to pydigger

Look at the list of missing stuff.
Pick a project.
Go to the github of the project.
make a change on the project's github (e.g. add the author to the setup.py file)
Send a pull request
Once the author of the project accepts the change and place it on pypi, pydigger will retrieve the change and be updated accordingly.

Lesson 7: Contribute to open source projects on GitHub

ShulyAvraham — Sun, 26 Feb 2023 14:59:56 +0000

Contribute to projects on GitHub

Contribute to dev.to

dev.to Is an open source project

We found an issue with auto save - so that when I write text, the system will automatically save it, or save changes but keep editing.

Built on Forem

Click the github link

Go to Issues

Before we open a new issue it is recommended to check if the issues was already addressed:

Use the Filters to search for the issue. Search for 'autosave'.

Can also search Pull requests or Discussions

Contribute to zarr-python

(https://github.com/zarr-developers/zarr-python)

Advance pull-request locally

E.g. I find that somebody sent a pull request with a solution to my problem, but it's not advancing.

I can advance that pull request on my end:

git clone <the project's github url>

Fetch the pull request by its number

git fetch origin pull/1357/head

git checkout -b b1357 FETCH-HEAD

Now I'm in a branch that contains the pull request code change.

FETCH_HEAD is a special file inside the '.git' folder, that was created when I run git fetch and it contains the SHA of the pull request.

cat .git/FETCH_HEAD

Just like HEAD is a file which points to where I am currently located locally (which SHA).

cat .git/HEAD

Now I will merge the pull request with the main branch into a new branch

git checkout main
git checkout -b szabgab
git merge b1357

HEAD is a pointer to where I am currently in the git commits tree.

Git Conflicts

git merge <some branch>

Might cause conflicts. To resolve the conflicts, first locate the conflicting files:

git status

Edit the conflicting file:

vim <file with conflict>

Search for '>>>' or '<<<' and edit the file to resolve the conflict.

To cancel the merge that caused conflicts

git merge --abort

Docker for running the project

An example for a docker image created by @szabgab :

https://github.com/szabgab/mydocker

docker build -t mydocker .

An alias to run the docker

alias dr='docker run -it --rm --workdir /opt -v$(pwd):/opt mydocker bash'
dr

Tests

It is recommended to find out how to run tests locally. It is normally somewhere in the docs.

Tests coverage report

Codecov Report

During the tests run on GitHub or GitLab, the source code is being analyzed for which lines of code run as a result of the tests run, meaning those lines of code are being tested. A report is generated with the percentage of lines that are being tested (lines of code that run during the tests).

It is recommended that the code coverage be closest to 100%.

Some code may be deprecated, hence its not tested, so the code should be removed.

Or, perhaps a new function was added without a test.

OSDC Lesson 6: Dockers

ShulyAvraham — Sun, 12 Feb 2023 15:20:15 +0000

Exit code in tests

R tests

Testthat is a library for tests in R

Exit code

Every program that runs on the command line sends an exit code after finishing.

Show the exit code of the last run program on the command line

echo $?

Programs that finished successfully without errors return exit code 0.

In languages like R, that have no assert like python, when in tests, when I don't get the desired result, I will exit and send an exit code of anything but 0.

exit(1)

Docker

An encapsulation of a unified environment.
Define a very specific environment.
One can control the environment.
Install a development environment relatively easily.
Separates between my computer to where I run code (eg when I download software from the web). With Docker I can limit the files that the Docker can see, as I map specific folder to docker.

Run docker

docker run --rm -it ubuntu:22.04 bash

--rm : remove the docker when finishes
--it : interactive
bash : run bash inside the docker
ubuntu : is the image
22.04 : Is a tag, normally a version of the image and contains the year and month

Unable to find image 'ubuntu:22.04' locally
22.04: Pulling from library/ubuntu
677076032cca: Pull complete
Digest: sha256:9a0bdde4188b896a372804be2384015e90e3f84906b750c1a53539b585fbbe7f
Status: Downloaded newer image for ubuntu:22.04
root@202e3c005b89:/#

Docker pulled the specific image from the image repository as it didn't find it locally on my computer.

Then I entered the docker into the bash command line.

root@202e3c005b89:/# apt-get update

Will bring me all the latest packages

root@202e3c005b89:/# apt-get install python3
root@202e3c005b89:/# python3
>>>

Now I can run python commands inside the docker...

Everything I will run will happen inside the docker container's file system.

Exit the image

root@202e3c005b89:/# exit

When I exit the docker everything will be removed.The file system of the docker container will be deleted (unless I use the -v flag, explained next).

There are many images in the docker hub. I can select any image that suits my purpose.

e.g. a python docker

docker run --rm -it python:3.22

PyDigger

A site that crawls the web and collects information about python packages

Look for an open source project to which you can contribute.

Clone the project by copying the project's ssh URL.

To see the source code inside the docker. I will ask the docker to map the project's folder to the docker's file system.

 docker run -it --rm -v /mnt/c/Users/shuly.avraham/
work/LIMS_results_validation/:/opt python:3.11 bash

The project's folder on my computer was mapped to the opt/ folder within the docker.

Now I can access the project's folder from within the docker container.

root@c6e9d5452e5f:/# ls opt/

I can still edit the project's files using my preferred editor on the computer and it will take effect inside the docker container.

Run tests inside the docker

pytest -svv tests/

where tests/ is the folder in which I write my tests, which name start with test_.

Dockerfile

Is a file where I write the configuration of my docker. I can start with a docker from docker hub and install more packages on it.

If I'm in a container, after installing several packages, if I leave the docker, the installations will be lost. I can then create an image from the container

docker freeze

Will create an image from within the container

The disadvantage is that I don't know what I installed.

A better way is to write a dockerfile with everything I want to install in my image. Let's call it mydocker

docker build -t mydocker

An alias to easily run docker from `mydocker` dockerfile

alias dr='docker run -it --rm --workdir /opt -v $(pwd):/opt mydocker bash'

GitHub Actions for Continous Integration

After I added tests to a project and pushed them to git, I will configure the CI in GitHub to run the tests automatically in every push/pull_request (and other) attempt.

GitHub actions is a service of GitHub where I can run commands on GitHub servers.

I will have my own server/s in GitHub in which I can run commands, and the server/s will close after the commands finish.

In order to configure it I will create a special directory and ci.yml file inside my project's git root dir:

mkdir -p .github/workflows

Inside it I will create a file ci.yml and edit it to configure the servers in which I will run my tests, and decide which OS and which languages versions

vi .github/workflows/ci.yml

Now git push will run my tests on the servers and configurations I mentioned in the ci.yml file.

I can go to the GitHub website of the project and check whether the tests succeeded or failed.

OSDC Lesson 5:

ShulyAvraham — Sun, 05 Feb 2023 13:15:47 +0000

Work locally on a project not owned by me

git clone git@github.com:ShulyAvraham/LIMS_results_validation.git

We see that there's an issue, the file requirements.txt is missing.

We can create it. Edit it to add the missing modules. In this case we're missing the pyinstaller module. We'll add it to the file according to the instructions.

Create a new branch

git checkout -b <username>/<branch-name>

It is advised to add my username in case someone else will use the same name.

git add requirements.txt

git commit -m'Add requirements file #2'

It is advised to add the issue number to the commit message.

git log

Git doesn't know where to push because the new branch is not mapped to remote, so the push needs to include the remote and the branch name.

git push origin <username>/<branch-name>

But it doesn't work because I don't have permissions on the project. Hence, I need to create my own fork of the project in my git.

I'll go to the project's git and create a fork on my own git by clicking fork->create a new fork-> I'll be the owner of the form -> Create fork

So now I have the project in my own user's git, on which I have write permissions.

Now I need to add the remote of my fork

I'll got to my fork code->ssh->Copy the URL

git remote add <any-name> <the-fork-url-in-github>

git remote add fork git@github.com:ShulyAvraham/osdc-site-generator.git

It adds the mapping to the .git/config file

git push --set-upstream fork <the-fork-url-in-github>

The flag --set-upstream adds to the .git/config lines that tell git to map this branch to the remote fork

The changes were pushed to my fork.

Going to the git website,

Gabor doesn't know about my changes. In order for him to see it, I need to create a pull request.

I go to the project on the GitHub site, and create a pull request

Gabor, on his project now sees the Pull request.

If Gabor is not happy with my changes, he can ask to fix it. Now every change that I will make to the branch and push out, will create a new pull request.

Pull request

Merge ...
Select one of 3 options...

Commit and merge -
Squize and merge - will squeeze all Gabor's commits to one
Rebase and merge -

Now I need to sync my local git with the remote main git that merged my changes.

git checkout main
git pull

If I want to work on something else

git checkout -b <another-branch-name>

See all the branches

git branch -a

git remote set-url origin --push <the remote git project not mine>

Merge and rebase

Are related to the behavior of git pull

The result of the merge and rebase are the same, it's only the commits history that is different.

I will make a local change on my local main branch.

git add
git commit -m'add comment'

Now I will accept a pull request which someone sent me a pull, and the change reached the main branch.

Now locally I have a change. I cannot push out, as what's in GitHub already changed.

I need to locally merge the remote changes with my local changes.

First I need to git pull in order to merge changes on the remote with my local changes.

gitk --all

Will show us graphically the changes

git fetch

Gets the changes from remote to my local copy, but will not merge with my local changes.

gitk --all

How to mix the two?

Merge
Rebase

Pull can either merge or rebase.

We can look at .git/config to see the behavior.

Merge

[pull]
    rebase=false

Merge takes both changes, remote and local and merges them.

Rebase

[pull]
    rebase=true

Normally git pull first does fetch and then merge.

The rebase takes my local changes and places them after the changes on the remote git. Only for the commits history purpose.

Testing for CI

ShulyAvraham — Sat, 04 Feb 2023 15:15:54 +0000

Slides & Examples

Check out testing demo in Python by @szabgab

Fixture

Is the testing environment prior to running the tests

Create a test

Create a new python script with a name starting with test_

vi test_myfunc.py

The python script should include

import mymodule # the mymodule file containing the myfunc function I want to test

def test_myfunc1():
    assert mymodule.myfunc("some input") == "some expected result"

def test_myfunc2():
    assert mymodule.myfunc("other input") == "other expected result"

I can add more test_ functions where each function is a test case.

Run the test

pytest test_myfunc.py

This will run all the test_ functions in test_myfunc.py and show whether the tests passed or failed, based on the expected results, per test function.

Tell pytest to run the tests in random order to make sure that the tests are independent of each other

pytest --rendom-order test_myfunc.py

OSDC Lesson 4: My project on GitHub

ShulyAvraham — Fri, 03 Feb 2023 19:35:36 +0000

Place my own project on GitHub

Enter my project's dir

cd <my-proj>

Add the project to git and create the repository

git init

a .git directory will be created

ls -l

Check the status of the git

git status

Add all files to the staging

git add .

Remove a file which I don't want to track on git from staging (e.g. python's cache file)

git reset <file>

git rm --cached <file>

git alias

Add the following to the ~/.gitconfig file.

[alias]
    st = status
    co = checkout
    ci = commit

git ignore

Add to the .gitginore file a list of files or folders that you want git to ignore, e.g. __pycache___

vi .gitignore

Add the .gitignore file to git

git add .gitignore

All the above referred to the local copy of my new git project.

Create a git project on GitHub

Go to your user's GitHub page
On the top right click +->New repository
Provide repository name - preferably with your project's root dir name (but not mandatory).
Select Public or Private (I selected Public)
Add a README file or .gitignore
- if I started with creating the project in GitHub and then clone it - I will select to add README and gitignore files.
- In my case, where I first created the repository locally, using the git init command and only then I careted the remote repo, I will choose not to add README and .gitignore files.
Click Create repository (empty one)
I will be provided instructions for connecting the remote with my local repositories.

Connect the remote and local repositories

Go back to the project root dir on the command line

git remote add origin git@github.com:ShulyAvraham/LIMS_results_validation.git
git remote -v

This will add the following lines to the .git/config file

[remote "origin"]
        url = git@github.com:ShulyAvraham/LIMS_results_validation.git
        fetch = +refs/heads/*:refs/remotes/origin/*

Map my branch to `main`

git branch -M main

Push repo to remote

The name of the remote is origin and the remote branch is main. The -u configs git to map this connection for later pushes.

git push -u origin main

This will add the following to the .git/config file

[branch "main"]
        remote = origin
        merge = refs/heads/main

This means that the my local branch main is mapped to the remote repo called origin and is merged to the remote main branch.

We can have several remotes, with different remotes for push and pulls (fetch).

Now I can see my source code on the project's GitHub page.

Correct the comment for my last commit before push

My first commit

git commit -m'some comment'

Let's look at the commit's sha

git log

Now change the comment for the last commit

git commit -m'a different comment' --amend

See the the sha was modified

git log

The next section will discuss Testing for continuous integration

Install Git CLI

ShulyAvraham — Fri, 03 Feb 2023 19:28:04 +0000

Git CLI

CLI is the command line for Git

Install GitHub CLI for Windows

Download the Git client for Windows
Install the CLI
- In Choose the default editor for used by git select your editor of preference.
- Select Override the default branch name for new repositories and enter 'main'
- In Choose the default behavior for 'git pull' select Rebase

This will install a bash command line prompt

SSH Key Pair

ShulyAvraham — Sun, 29 Jan 2023 13:53:35 +0000

SSH-Key

Accessing a remote repository via SSH without the need to provide username and password every time I pull or push.

Go to your command line prompt (e.g. the GitHub CLI installed previously), and run:

ssh-keygen

Use the same command for Windows, only with .exe extension.

Just hit Enter for each of the questions asked...
It will generate a .ssh/ directory in your home dir with key-pair inside, in the form of 2 files:
- id_rsa - is the private key - which I always keep locally on my computer
- id_rsa.pub is the public key - which I can publish somewhere on the internet

ls ~/.ssh

View and copy the contents of id-rsa.pub (depending on the OS you're using, use the appropriate editor or file viewer, here I will use Linux command cat or less. On Windows one might use Notepad).

cat ~/.ssh/id-rsa.pub

Copy the file content
Go back to your GitHub account page: Click Setting->SSH and GPG keys->New SSH key->paste the public key into the Key text box, provide some Title-> Add SSH key.
Once this is done, I will not need to provide my username and password every time I communicate with the remote repo.
This key pair might be copied over and used over several computers

OSDC Lesson 3: GitHub CLI

ShulyAvraham — Sat, 28 Jan 2023 16:42:48 +0000

Git CLI

Install git CLI

Work on my repo via CLI

To work locally on the repository owned by me via the command line I first need to clone it.

Clone the repository locally

Go to my repo online
Click Code
- Select either HTTPS or SSH
  - SSH: Recommended!
    - We will need authentication in the form of SSH key
  - HTTPS: In case for some reason the SSH will not work, we can use HTTPS since it's a public project, but it will require authentication for every pull and push.
- Open the installed command line (e.g. bash on Linux, GitHub CLI)
- Copy the URL to paste in the git clone command
- Answer yes to the question whether you're sure you want to connect...

git clone git@github.com:ShulyAvraham/shulyavraham.github.io.git

A folder with the repository is created locally.
This folder can be moved anywhere, as all the information is contained within it.
I can now edit files in any editor or via the command line
To run git commands I should enter this folder

ls -l
cd shulyavraham.github.io.git

Git CLI commands

Communicate between my local repository and my own remote repository (vs. a public open source repo not owned by me).

The recommendation for continuous integration is for all users to work on the same main branch. This is to quickly identify and prevent conflicts during merge.

Edit files and interact with git

Open a file using some editor, edit then save it.

From the command line:

Let's see what changed in git

git status

It will show that the file was modified (since the last commit). Now the file is only changed locally, but not in git. In order to add it to git:

git add filename

Another git status will reveal that the file was added to git's staging area. In order add it to the git repo we will commit the changes:

git commit -m'a comment describing the change'

The first time I communicate with git it will recommend me to configure my username and email. These are not being checked, but used to identify whom preformed which commit.

git config --global user.name "Shuly Avraham"
git config --global user.email"Shuly.Avraham@mymail.com"

After the commit, another git status will reveal that there's nothing to commit and that my tree is clean.

However, my branch is ahead of origin/main. origin represents the remote repository. So that my local branch is 1 commit ahead of the remote branch.

To push my change to my remote repo

git push

git push origin main

Another git status will reveal that my local repo is identical to the remote repo, of the main branch.

Since I did git push, I can now see the changes on the remote site.

Add a new file. git status will show that the file is untracked.

Modify another file.

Now we have two files that are unstaged. We can add all the modified to the staging area

git add .

Now the next commit will include both changes.

If I want only specific file or files to be included in a specific commit, even though I made changes to other files as well, I will specify the file names in the git add, and then commit.

git add somefilename
git commit -m'A specific change'

It is advised to include only files with related changes in a specific commit.

To check what changed since the last commit to my local changes

git diff

To see changes since last commit to my staging area

git diff --staged

To restore files from staging area

git restore --staged filename

To see my history of commits

git log

A tool to view changes

gitk --all

Cancel and delete last commit. NOT RECOMMENDED

git reset HEAD~1

The number represents the number of commits back.

The change is still in my local file. To delete also the local change

git reset HEAD~1 –hard

To see a change in a specific commit

git show sha_of_commit

To see the difference between a commit and what I have now

git diff sha_of_commit

Some more commands

git rm --cached <file>

Remove from staging

git reset file

Remote mapping

git remote -v

We will see the mapping of the remote repos for fetch (pull) and push. Normally origin, but this can be changed. Also, we can have different remotes for pull and push.

The .git directory

Inside the root dir of our local repo

ls -l

Will reveal the .git directory which contains all the changes to the git repo.

config file contains git configuration. (such as user info, remote repo info, etc.]

It can be edited directly or by git configuration commands via the command line which will keep changes in this file.

Deploy and run the OSDC website locally

ShulyAvraham — Mon, 16 Jan 2023 08:20:19 +0000

Follow these steps to deploy the OSDC code and run the website locally

Assuming you have Python installed locally on a Linux machine or WSL (Windows Subsystem for Linux) on Windows
Run the following on Linux shell:

$ git clone https://github.com/ShulyAvraham/osdc-2023-01-public.git
$ cd osdc-2023-01-public
$ sudo apt install python3-pip # If you don't already have one
$ pip install -r requirements.txt
$ python generate.py 
$ python app.py

On your web browser open the OSDC website http://127.0.0.1:5000

Markdown tips beyond basics on dev.to

ShulyAvraham — Sun, 15 Jan 2023 15:15:44 +0000

Create a series of blog posts

To make a series out of several blog posts, add the following to the beginning of every post in that series:

---
series: SomeSeriesName
---

Link to somebody's dev.to profile

For example:
@shulyavraham

@person_username

Include an embedded person's card

For example:

ShulyAvrahamFollow

Works at Hazera Seeds, Israel.

{% embed https://personBlogURL.com %}

OSDC lesson 2: Create a website for you and your projects on github

ShulyAvraham — Sun, 15 Jan 2023 15:05:00 +0000

GitHub pages

Create my own website on GitHub step by step

Create a repository github_username.github.io

Within my GitHub create a new repository:
- Click Repositories
- Click New
- Repository name must be: github_username.github.io, in my case shulyavraham.github.io
- Click Create repository
- So, now I have a new repository
Create a new file named index.md in the new repo
- Add some markdown text to the file and click Commit new file

Generate the pages

Create the pages

Click Settings on the top menu
Click Pages on the left menu
Select Deploy from branch in the Source drop down
Select the main branch
You can select the directory which will server the pages, either root or docs
Click Save

View my website

Now my website was created with an index page

Go to the URL shulyavraham.github.io in the browser
You should see the index page you crated previously

Edit the website and add new pages

The markdown file can now be edited and committed to design the page
- This is now my own project, so I can Commit changes to my own repo
- Any commit to the page will result in the deployment of the web page, which I can view on my website
- GitHub automatically generates HTML from my markdown files using Jekyll

I can now create more pages in an .md format which will be generated to HTML when committed.

Create a new file about.md and edit it
Link to the new page from the index page
- Edit index.md and add:

[Link to about](about)

Configure my web pages theme

Go to my repo
Create a new file in the root dir Add file->Create new file->File name: '_config.yml'
Edit the file to add a theme and title to my pages

theme: jekyll-theme-cayman
title: ShulyA's GitHub Page

Commit new file
View my website with the new theme (it may take a few seconds for the changes to take effect)

Supported themes for GitHub pages

To use one of the supported themes add the following to the _config.yml file

remote_theme: pages-themes/architect@v0.2.0 # depending on the selected theme
plugins:
- jekyll-remote-theme # add this line to the plugins list if you already have one

Use your own domain to redirect to the GitHub site

3 things must happen, the first 2 are external to GitHub

You have your own domain name e.g. github.shulyavraham.com
Configure your host provider so that your hostname will map to GitHub
Add a file called CNAME to your GitHub repo, and edit it to include the hostname, e.g.

github.shulyavraham.com

Add other repositories as subfolders of the main site

If I have other repos from which I generate GitHub pages, they will automatically appear as sub folders of my main site repo

Create a new repo qqrq
Go to Settings->Pages->Save
The new repo's site pages will be generated and added as sub folder to the main repo website

Some tips

Embed an image from the web on my page

Search for an image on google
Select the image
Right click the image and select Copy image address
In the markdown file add:

![](http://the_image_address/image_name.jpg)

Modify the main index page to be served from /docs rather than /root

In case you initially chose to serve the website from the /root dir, but decided to change it to the /docs dir

Go to Settings->Pages->Branch->Select /Docs->Save

DEV Community: ShulyAvraham

OSDC LESSON 8: Webhooks, git stash, tests coverage report

GitHub

Webhooks

git stash

Docker playground

Run a project from git inside docker

make and Makefile

tox

Coverage report for tests

contribute to pydigger

Lesson 7: Contribute to open source projects on GitHub

Contribute to projects on GitHub

Contribute to dev.to

Contribute to zarr-python

Advance pull-request locally

Git Conflicts

Docker for running the project

Tests

Tests coverage report

OSDC Lesson 6: Dockers

Exit code in tests

R tests

Exit code

Docker

Run docker

PyDigger

Run tests inside the docker

Dockerfile

An alias to easily run docker from mydocker dockerfile

GitHub Actions for Continous Integration

OSDC Lesson 5:

Work locally on a project not owned by me

Create a new branch

Pull request

Merge and rebase

Testing for CI

Slides & Examples

Fixture

Create a test

OSDC Lesson 4: My project on GitHub

Place my own project on GitHub

git alias

git ignore

Create a git project on GitHub

Connect the remote and local repositories

Map my branch to main

Push repo to remote

Correct the comment for my last commit before push

Install Git CLI

Git CLI

Install GitHub CLI for Windows

SSH Key Pair

SSH-Key

OSDC Lesson 3: GitHub CLI

Git CLI

Work on my repo via CLI

Clone the repository locally

Git CLI commands

Edit files and interact with git

Remote mapping

The .git directory

Deploy and run the OSDC website locally

Follow these steps to deploy the OSDC code and run the website locally

Markdown tips beyond basics on dev.to

Create a series of blog posts

Link to somebody's dev.to profile

Include an embedded person's card

ShulyAvrahamFollow

OSDC lesson 2: Create a website for you and your projects on github

GitHub pages

Create my own website on GitHub step by step

Create a repository github_username.github.io

Generate the pages

View my website

Edit the website and add new pages

Configure my web pages theme

Use your own domain to redirect to the GitHub site

Add other repositories as subfolders of the main site

Some tips

An alias to easily run docker from `mydocker` dockerfile

Map my branch to `main`