Github

Github Automation Documentation

Inital Connection

Create ssh key pair

ssh-keygen -t ed25519 -C "your_email@example.com"

Add the SSH Key to the SSH Agent

eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_ed25519

Add the SSH Key to Your GitHub Account

Test the SSH Connection to GitHub

ssh -T git@github.com

Automation

Quickstart

For GitHub to discover any GitHub Actions workflows in your repository, you must save the workflow files in a directory called .github/workflows.

You can give the workflow file any name you like, but you must use .yml or .yaml as the file name extension. YAML is a markup language that’s commonly used for configuration files.

Create .github/workflows/actions.yml

name: GitHub Actions Demo
run-name: ${{ github.actor }} is testing out GitHub Actions πŸš€
on: [push]
jobs:
  Explore-GitHub-Actions:
    runs-on: ubuntu-latest
    steps:
      - run: echo "πŸŽ‰ The job was automatically triggered by a ${{ github.event_name }} event."
      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
      - run: echo "πŸ”Ž The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
      - name: Check out repository code
        uses: actions/checkout@v4
      - run: echo "πŸ’‘ The ${{ github.repository }} repository has been cloned to the runner."
      - run: echo "πŸ–₯️ The workflow is now ready to test your code on the runner."
      - name: List files in the repository
        run: |
          ls ${{ github.workspace }}
      - run: echo "🍏 This job's status is ${{ job.status }}."

Overview

GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform that allows you to automate your build, test, and deployment pipeline. You can create workflows that build and test every pull request to your repository, or deploy merged pull requests to production.

GitHub Actions goes beyond just DevOps and lets you run workflows when other events happen in your repository. For example, you can run a workflow to automatically add the appropriate labels whenever someone creates a new issue in your repository.

GitHub provides Linux, Windows, and macOS virtual machines to run your workflows, or you can host your own self-hosted runners in your own data center or cloud infrastructure.

Events

An event is a specific activity in a repository that triggers a workflow run. For example, an activity can originate from GitHub when someone creates a pull request, opens an issue, or pushes a commit to a repository. You can also trigger a workflow to run on a schedule, by posting to a REST API, or manually.

Jobs

A workflow run is made up of one or more jobs, which run in parallel by default. To run jobs sequentially, you can define dependencies on other jobs using the jobs..needs keyword.

jobs:
  my_first_job:
    name: My first job
  my_second_job:
    name: My second job

Actions

An action is a custom application for the GitHub Actions platform that performs a complex but frequently repeated task. Use an action to help reduce the amount of repetitive code that you write in your workflow files. An action can pull your git repository from GitHub, set up the correct toolchain for your build environment, or set up the authentication to your cloud provider.

Runners

A runner is a server that runs your workflows when they’re triggered. Each runner can run a single job at a time.

# Optional - The name of the workflow as it will appear in the "Actions" tab of the GitHub repository. If this field is omitted, the name of the workflow file will be used instead.
name: learn-github-actions

# Optional - The name for workflow runs generated from the workflow, which will appear in the list of workflow runs on your repository's "Actions" tab. This example uses an expression with the `github` context to display the username of the actor that triggered the workflow run. For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#run-name)."
run-name: ${{ github.actor }} is learning GitHub Actions

# Specifies the trigger for this workflow. This example uses the `push` event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request.  This is triggered by a push to every branch; for examples of syntax that runs only on pushes to specific branches, paths, or tags, see "[AUTOTITLE](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore)."
on: [push]

# Groups together all the jobs that run in the `learn-github-actions` workflow.
jobs:

# Defines a job named `check-bats-version`. The child keys will define properties of the job.
  check-bats-version:

# Configures the job to run on the latest version of an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub. For syntax examples using other runners, see "[AUTOTITLE](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)"
    runs-on: ubuntu-latest

# Groups together all the steps that run in the `check-bats-version` job. Each item nested under this section is a separate action or shell script.
    steps:

# The `uses` keyword specifies that this step will run `v4` of the `actions/checkout` action. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). You should use the checkout action any time your workflow will use the repository's code.
      - uses: actions/checkout@v4

# This step uses the `actions/setup-node@v4` action to install the specified version of the Node.js. (This example uses version 20.) This puts both the `node` and `npm` commands in your `PATH`.
      - uses: actions/setup-node@v4
        with:
          node-version: '20'

# The `run` keyword tells the job to execute a command on the runner. In this case, you are using `npm` to install the `bats` software testing package.
      - run: npm install -g bats

# Finally, you'll run the `bats` command with a parameter that outputs the software version.
      - run: bats -v
!cat ../.github/workflows/deploy.yaml
name: Deploy to GitHub Pages

permissions:
  contents: write
  pages: write

on:
  push:
    branches: [ "main", "master" ]
  workflow_dispatch:
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps: [uses: fastai/workflows/quarto-ghp@master]
!cat ../.github/workflows/test.yaml
name: CI
on:  [workflow_dispatch, pull_request, push]

jobs:
  test:
    runs-on: ubuntu-latest
    steps: [uses: fastai/workflows/nbdev-ci@master]

CLI

!gh
Work seamlessly with GitHub from the command line.

USAGE
  gh <command> <subcommand> [flags]

CORE COMMANDS
  auth:        Authenticate gh and git with GitHub
  browse:      Open the repository in the browser
  codespace:   Connect to and manage codespaces
  gist:        Manage gists
  issue:       Manage issues
  org:         Manage organizations
  pr:          Manage pull requests
  project:     Work with GitHub Projects.
  release:     Manage releases
  repo:        Manage repositories

GITHUB ACTIONS COMMANDS
  cache:       Manage GitHub Actions caches
  run:         View details about workflow runs
  workflow:    View details about GitHub Actions workflows

ALIAS COMMANDS
  co:          Alias for "pr checkout"

ADDITIONAL COMMANDS
  alias:       Create command shortcuts
  api:         Make an authenticated GitHub API request
  attestation: Work with artifact attestations
  completion:  Generate shell completion scripts
  config:      Manage configuration for gh
  extension:   Manage gh extensions
  gpg-key:     Manage GPG keys
  label:       Manage labels
  ruleset:     View info about repo rulesets
  search:      Search for repositories, issues, and pull requests
  secret:      Manage GitHub secrets
  ssh-key:     Manage SSH keys
  status:      Print information about relevant issues, pull requests, and notifications across repositories
  variable:    Manage GitHub Actions variables

HELP TOPICS
  actions:     Learn about working with GitHub Actions
  environment: Environment variables that can be used with gh
  exit-codes:  Exit codes used by gh
  formatting:  Formatting options for JSON data exported from gh
  mintty:      Information about using gh with MinTTY
  reference:   A comprehensive reference of all gh commands

FLAGS
  --help      Show help for command
  --version   Show gh version

EXAMPLES
  $ gh issue create
  $ gh repo clone cli/cli
  $ gh pr checkout 321

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

Authentication

Only if needed

!gh auth
Authenticate gh and git with GitHub

USAGE
  gh auth <command> [flags]

AVAILABLE COMMANDS
  login:       Log in to a GitHub account
  logout:      Log out of a GitHub account
  refresh:     Refresh stored authentication credentials
  setup-git:   Setup git with GitHub CLI
  status:      Display active account and authentication state on each known GitHub host
  switch:      Switch active GitHub account
  token:       Print the authentication token gh uses for a hostname and account

INHERITED FLAGS
  --help   Show help for command

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

Useful commands

gh auth login
!gh auth status
github.com
  βœ“ Logged in to github.com account bthek1 (GITHUB_TOKEN)
  - Active account: true
  - Git operations protocol: https
  - Token: ghp_************************************
  - Token scopes: 'admin:enterprise', 'admin:gpg_key', 'admin:org', 'admin:org_hook', 'admin:public_key', 'admin:repo_hook', 'admin:ssh_signing_key', 'audit_log', 'codespace', 'copilot', 'delete:packages', 'delete_repo', 'gist', 'notifications', 'project', 'repo', 'user', 'workflow', 'write:discussion', 'write:packages'

Alias

!gh help alias set
Define a word that will expand to a full gh command when invoked.

The expansion may specify additional arguments and flags. If the expansion includes
positional placeholders such as `$1`, extra arguments that follow the alias will be
inserted appropriately. Otherwise, extra arguments will be appended to the expanded
command.

Use `-` as expansion argument to read the expansion string from standard input. This
is useful to avoid quoting issues when defining expansions.

If the expansion starts with `!` or if `--shell` was given, the expansion is a shell
expression that will be evaluated through the `sh` interpreter when the alias is
invoked. This allows for chaining multiple commands via piping and redirection.


USAGE
  gh alias set <alias> <expansion> [flags]

FLAGS
      --clobber   Overwrite existing aliases of the same name
  -s, --shell     Declare an alias to be passed through a shell interpreter

INHERITED FLAGS
  --help   Show help for command

EXAMPLES
  # note: Command Prompt on Windows requires using double quotes for arguments
  $ gh alias set pv 'pr view'
  $ gh pv -w 123  #=> gh pr view -w 123
  
  $ gh alias set bugs 'issue list --label=bugs'
  $ gh bugs
  
  $ gh alias set homework 'issue list --assignee @me'
  $ gh homework
  
  $ gh alias set 'issue mine' 'issue list --mention @me'
  $ gh issue mine
  
  $ gh alias set epicsBy 'issue list --author="$1" --label="epic"'
  $ gh epicsBy vilmibm  #=> gh issue list --author="vilmibm" --label="epic"
  
  $ gh alias set --shell igrep 'gh issue list --label="$1" | grep "$2"'
  $ gh igrep epic foo  #=> gh issue list --label="epic" | grep "foo"

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

!gh alias list
co: pr checkout

Repos

!gh repo
Work with GitHub repositories.

USAGE
  gh repo <command> [flags]

GENERAL COMMANDS
  create:      Create a new repository
  list:        List repositories owned by user or organization

TARGETED COMMANDS
  archive:     Archive a repository
  clone:       Clone a repository locally
  delete:      Delete a repository
  deploy-key:  Manage deploy keys in a repository
  edit:        Edit repository settings
  fork:        Create a fork of a repository
  rename:      Rename a repository
  set-default: Configure default repository for this directory
  sync:        Sync a repository
  unarchive:   Unarchive a repository
  view:        View a repository

INHERITED FLAGS
  --help   Show help for command

ARGUMENTS
  A repository can be supplied as an argument in any of the following formats:
  - "OWNER/REPO"
  - by URL, e.g. "https://github.com/OWNER/REPO"

EXAMPLES
  $ gh repo create
  $ gh repo clone cli/cli
  $ gh repo view --web

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

Creating a Repository

gh repo create my-new-repo

Example

gh repo create test_gh --public --add-readme --description "Github CLI Testing"

List Repos

!gh repo list -L 10

Showing 10 of 47 repositories in @bthek1

NAME                   DESCRIPTION              INFO          UPDATED           
bthek1/WEB_doc         webdevelopment_doc       public        about 16 hours ago
bthek1/githubAuto      Testing github Autom...  public        about 17 hours ago
bthek1/keybr.com       The smartest way to ...  public, fork  about 18 hours ago
bthek1/Dotfiles        Dotfiles                 private       about 18 hours ago
bthek1/Business_doc                             private       about 21 hours ago
bthek1/DL_methods      Deep Learning models...  public        about 1 day ago
bthek1/Python_Libs     Usefull libraries fo...  public        about 2 days ago
bthek1/Resume          latex resume             private       about 2 days ago
bthek1/Philosophy_doc                           private       about 2 days ago
bthek1/B_Blog          Personal Blog            public        about 2 days ago

Delete a Repo

gh repo delete <name>
!gh repo deploy-key list
no deploy keys found in bthek1/WEB_doc

Release

!gh release
Manage releases

USAGE
  gh release <command> [flags]

GENERAL COMMANDS
  create:      Create a new release
  list:        List releases in a repository

TARGETED COMMANDS
  delete:      Delete a release
  delete-asset: Delete an asset from a release
  download:    Download release assets
  edit:        Edit a release
  upload:      Upload assets to a release
  view:        View information about a release

FLAGS
  -R, --repo [HOST/]OWNER/REPO   Select another repository using the [HOST/]OWNER/REPO format

INHERITED FLAGS
  --help   Show help for command

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

Create Release

gh repo create

List Releases

!gh release list
TITLE               TYPE         TAG NAME      PUBLISHED          
test_release_title  Pre-release  test_release  about 6 minutes ago

View Release

gh release view [<tag>] [flags]
!gh release view test_release
11;?test_release
Pre-release β€’ bthek1 released this about 7 minutes ago

  test release notes                                                          


View on GitHub: https://github.com/bthek1/WEB_doc/releases/tag/test_release

Codespaces

!gh codespace
Connect to and manage codespaces

USAGE
  gh codespace [flags]

ALIASES
  gh cs

AVAILABLE COMMANDS
  code:        Open a codespace in Visual Studio Code
  cp:          Copy files between local and remote file systems
  create:      Create a codespace
  delete:      Delete codespaces
  edit:        Edit a codespace
  jupyter:     Open a codespace in JupyterLab
  list:        List codespaces
  logs:        Access codespace logs
  ports:       List ports in a codespace
  rebuild:     Rebuild a codespace
  ssh:         SSH into a codespace
  stop:        Stop a running codespace
  view:        View details about a codespace

INHERITED FLAGS
  --help   Show help for command

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

Extensions

!gh extension
GitHub CLI extensions are repositories that provide additional gh commands.

The name of the extension repository must start with `gh-` and it must contain an
executable of the same name. All arguments passed to the `gh <extname>` invocation
will be forwarded to the `gh-<extname>` executable of the extension.

An extension cannot override any of the core gh commands. If an extension name conflicts
with a core gh command, you can use `gh extension exec <extname>`.

For the list of available extensions, see <https://github.com/topics/gh-extension>.


USAGE
  gh extension [flags]

ALIASES
  gh extensions, gh ext

AVAILABLE COMMANDS
  browse:      Enter a UI for browsing, adding, and removing extensions
  create:      Create a new extension
  exec:        Execute an installed extension
  install:     Install a gh extension from a repository
  list:        List installed extension commands
  remove:      Remove an installed extension
  search:      Search extensions to the GitHub CLI
  upgrade:     Upgrade installed extensions

INHERITED FLAGS
  --help   Show help for command

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

!gh extension list
no installed extensions found

gpg-key

!gh gpg-key
Manage GPG keys registered with your GitHub account.

USAGE
  gh gpg-key <command> [flags]

AVAILABLE COMMANDS
  add:         Add a GPG key to your GitHub account
  delete:      Delete a GPG key from your GitHub account
  list:        Lists GPG keys in your GitHub account

INHERITED FLAGS
  --help   Show help for command

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

Label

!gh label
Work with GitHub labels.

USAGE
  gh label <command> [flags]

AVAILABLE COMMANDS
  clone:       Clones labels from one repository to another
  create:      Create a new label
  delete:      Delete a label from a repository
  edit:        Edit a label
  list:        List labels in a repository

FLAGS
  -R, --repo [HOST/]OWNER/REPO   Select another repository using the [HOST/]OWNER/REPO format

INHERITED FLAGS
  --help   Show help for command

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

!gh label list
6mβ’Ώ
Showing 9 of 9 labels in bthek1/WEB_doc

NAME              DESCRIPTION                                 COLOR  
bug               Something isn't working                     #d73a4a
documentation     Improvements or additions to documentation  #0075ca
duplicate         This issue or pull request already exists   #cfd3d7
enhancement       New feature or request                      #a2eeef
good first issue  Good for newcomers                          #7057ff
help wanted       Extra attention is needed                   #008672
invalid           This doesn't seem right                     #e4e669
question          Further information is requested            #d876e3
wontfix           This will not be worked on                  #ffffff

Organisation

!gh org
Work with GitHub organizations.

USAGE
  gh org <command> [flags]

GENERAL COMMANDS
  list:        List organizations for the authenticated user.

INHERITED FLAGS
  --help   Show help for command

EXAMPLES
  $ gh org list

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

!gh org list

Showing 2 of 2 organizations

Laser-org
Recovery-Mertics

Projects

!gh project
Work with GitHub Projects. Note that the token you are using must have 'project' scope, which is not set by default. You can verify your token scope by running 'gh auth status' and add the project scope by running 'gh auth refresh -s project'.

USAGE
  gh project <command> [flags]

AVAILABLE COMMANDS
  close:       Close a project
  copy:        Copy a project
  create:      Create a project
  delete:      Delete a project
  edit:        Edit a project
  field-create: Create a field in a project
  field-delete: Delete a field in a project
  field-list:  List the fields in a project
  item-add:    Add a pull request or an issue to a project
  item-archive: Archive an item in a project
  item-create: Create a draft issue item in a project
  item-delete: Delete an item from a project by ID
  item-edit:   Edit an item in a project
  item-list:   List the items in a project
  link:        Link a project to a repository or a team
  list:        List the projects for an owner
  mark-template: Mark a project as a template
  unlink:      Unlink a project from a repository or a team
  view:        View a project

INHERITED FLAGS
  --help   Show help for command

EXAMPLES
  $ gh project create --owner monalisa --title "Roadmap"
  $ gh project view 1 --owner cli --web
  $ gh project field-list 1 --owner cli
  $ gh project item-list 1 --owner cli

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

!gh project list
NUMBER  TITLE     STATE  ID                  
8       Schedule  open   PVT_kwHOBNe82M4AgAdx
!gh project field-list 8 --owner "@me"
NAME                  DATA TYPE                   ID                            
Title                 ProjectV2Field              PVTF_lAHOBNe82M4AgAdxzgVNpz0
Assignees             ProjectV2Field              PVTF_lAHOBNe82M4AgAdxzgVNpz4
Status                ProjectV2SingleSelectField  PVTSSF_lAHOBNe82M4AgAdxzgVNpz8
Labels                ProjectV2Field              PVTF_lAHOBNe82M4AgAdxzgVNp0A
Linked pull requests  ProjectV2Field              PVTF_lAHOBNe82M4AgAdxzgVNp0E
Milestone             ProjectV2Field              PVTF_lAHOBNe82M4AgAdxzgVNp0I
Repository            ProjectV2Field              PVTF_lAHOBNe82M4AgAdxzgVNp0M
Reviewers             ProjectV2Field              PVTF_lAHOBNe82M4AgAdxzgVNp0Y
date                  ProjectV2Field              PVTF_lAHOBNe82M4AgAdxzgVNp0k
end date              ProjectV2Field              PVTF_lAHOBNe82M4AgAdxzgVNp0o
Priority              ProjectV2SingleSelectField  PVTSSF_lAHOBNe82M4AgAdxzgVNp0w
Difficulty            ProjectV2SingleSelectField  PVTSSF_lAHOBNe82M4AgAdxzgVNp00
Iteration             ProjectV2IterationField     PVTIF_lAHOBNe82M4AgAdxzgVNxEY
!gh project item-list 8 --owner "@me"
TYPE   TITLE              NUMBER  REPOSITORY        ID                          
Issue  state manageme...  12      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMt94
Issue  provide link t...  22      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuBI
Issue  persisting use...  21      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuBQ
Issue  login via Goog...  20      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuBU
Issue  dynamic action...  19      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuBY
Issue  notifications ...  18      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuBc
Issue  login via phis...  17      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuBg
Issue  Django             7       bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuCE
Issue  React              8       bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuB8
Issue  Oracle: deploy...  6       bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuB0
Issue  navigation (do...  14      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuBs
Issue  connecting to ...  13      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuBw
Issue  3D vision          11      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuB4
Issue  DRF                28      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgQf6rg
Issue  DjangoX            29      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgQf9Lo
Issue  nookal             30      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgQf9L8
Issue  json serializa...  15      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuBo
Issue  displaying a c...  16      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMuBk
Issue  Random forward...  2       bthek1/DL_met...  PVTI_lAHOBNe82M4AgAdxzgOMvTc
Issue  github automation  26      bthek1/WEB_doc    PVTI_lAHOBNe82M4AgAdxzgOMx7c
Issue  Image classifi...  18      bthek1/DL_met...  PVTI_lAHOBNe82M4AgAdxzgPE1cc
Issue  Image mulit cl...  19      bthek1/DL_met...  PVTI_lAHOBNe82M4AgAdxzgPE1ew
Issue  object detecti...  20      bthek1/DL_met...  PVTI_lAHOBNe82M4AgAdxzgPE1hk
Issue  semantic segme...  21      bthek1/DL_met...  PVTI_lAHOBNe82M4AgAdxzgPE1zc
Issue  instance segme...  22      bthek1/DL_met...  PVTI_lAHOBNe82M4AgAdxzgPE12c
Issue  panoptic segme...  23      bthek1/DL_met...  PVTI_lAHOBNe82M4AgAdxzgPE18Y
Issue  Ideas - model ...  24      bthek1/DL_met...  PVTI_lAHOBNe82M4AgAdxzgPE1-8
Issue  ideas - image ...  25      bthek1/DL_met...  PVTI_lAHOBNe82M4AgAdxzgPE2BI
Issue  random propaga...  26      bthek1/DL_met...  PVTI_lAHOBNe82M4AgAdxzgPE2Cg
Issue  do one kaggle ...  27      bthek1/DL_met...  PVTI_lAHOBNe82M4AgAdxzgPE3BM

Issue

!gh issue
Work with GitHub issues.

USAGE
  gh issue <command> [flags]

GENERAL COMMANDS
  create:      Create a new issue
  list:        List issues in a repository
  status:      Show status of relevant issues

TARGETED COMMANDS
  close:       Close issue
  comment:     Add a comment to an issue
  delete:      Delete issue
  develop:     Manage linked branches for an issue
  edit:        Edit issues
  lock:        Lock issue conversation
  pin:         Pin a issue
  reopen:      Reopen issue
  transfer:    Transfer issue to another repository
  unlock:      Unlock issue conversation
  unpin:       Unpin a issue
  view:        View an issue

FLAGS
  -R, --repo [HOST/]OWNER/REPO   Select another repository using the [HOST/]OWNER/REPO format

INHERITED FLAGS
  --help   Show help for command

ARGUMENTS
  An issue can be supplied as argument in any of the following formats:
  - by number, e.g. "123"; or
  - by URL, e.g. "https://github.com/OWNER/REPO/issues/123".

EXAMPLES
  $ gh issue list
  $ gh issue create --label bug
  $ gh issue view 123 --web

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

!gh issue list

Showing 17 of 17 open issues in bthek1/WEB_doc

ID   TITLE                                            LABELS  UPDATED           
#30  nookal                                                   about 11 days ago
#29  DjangoX                                                  about 11 days ago
#28  DRF                                                      about 11 days ago
#22  provide link to external website (analytics....          about 4 months ago
#21  persisting user settings (built-in?)                     about 4 months ago
#20  login via Google (todo), done in Django, the...          about 4 months ago
#19  dynamic actions in chart: e.g change time range          about 4 months ago
#18  notifications (todo) - poll a REST API (todo...          about 4 months ago
#17  login via phisaver REST API (done)                       about 4 months ago
#16  displaying a chart - fl_chart (done)                     about 4 months ago
#15  json serialization / deserialisation (done)              about 4 months ago
#14  navigation (done), forget the name of framew...          about 4 months ago
#13  connecting to a REST API (done)                          about 4 months ago
#12  state management: riverpod (done)                        about 4 months ago
#11  3D vision                                                about 6 months ago
#8   React                                                    about 6 months ago
#6   Oracle: deploy server website and server                 about 4 months ago
!gh issue view 28
github automation bthek1/WEB_doc#26
Open β€’ bthek1 opened about 2 months ago β€’ 0 comments


  No description provided


View this issue on GitHub: https://github.com/bthek1/WEB_doc/issues/26
!gh issue edit 28 --add-label "enhancement"
https://github.com/bthek1/WEB_doc/issues/265h
!gh issue close 26
! Issue bthek1/WEB_doc#26 (github automation) is already closed

Pull Request

!gh pr
Work with GitHub pull requests.

USAGE
  gh pr <command> [flags]

GENERAL COMMANDS
  create:      Create a pull request
  list:        List pull requests in a repository
  status:      Show status of relevant pull requests

TARGETED COMMANDS
  checkout:    Check out a pull request in git
  checks:      Show CI status for a single pull request
  close:       Close a pull request
  comment:     Add a comment to a pull request
  diff:        View changes in a pull request
  edit:        Edit a pull request
  lock:        Lock pull request conversation
  merge:       Merge a pull request
  ready:       Mark a pull request as ready for review
  reopen:      Reopen a pull request
  review:      Add a review to a pull request
  unlock:      Unlock pull request conversation
  view:        View a pull request

FLAGS
  -R, --repo [HOST/]OWNER/REPO   Select another repository using the [HOST/]OWNER/REPO format

INHERITED FLAGS
  --help   Show help for command

ARGUMENTS
  A pull request can be supplied as argument in any of the following formats:
  - by number, e.g. "123";
  - by URL, e.g. "https://github.com/OWNER/REPO/pull/123"; or
  - by the name of its head branch, e.g. "patch-1" or "OWNER:patch-1".

EXAMPLES
  $ gh pr checkout 353
  $ gh pr create --fill
  $ gh pr view --web

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

Workflows

!gh workflow
List, view, and run workflows in GitHub Actions.

USAGE
  gh workflow <command> [flags]

AVAILABLE COMMANDS
  disable:     Disable a workflow
  enable:      Enable a workflow
  list:        List workflows
  run:         Run a workflow by creating a workflow_dispatch event
  view:        View the summary of a workflow

FLAGS
  -R, --repo [HOST/]OWNER/REPO   Select another repository using the [HOST/]OWNER/REPO format

INHERITED FLAGS
  --help   Show help for command

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

!gh workflow list
NAME                    STATE   ID      
Deploy to GitHub Pages  active  75582852
CI                      active  75582853
pages-build-deployment  active  75583140

Runs

!gh run
List, view, and watch recent workflow runs from GitHub Actions.

USAGE
  gh run <command> [flags]

AVAILABLE COMMANDS
  cancel:      Cancel a workflow run
  delete:      Delete a workflow run
  download:    Download artifacts generated by a workflow run
  list:        List recent workflow runs
  rerun:       Rerun a run
  view:        View a summary of a workflow run
  watch:       Watch a run until it completes, showing its progress

FLAGS
  -R, --repo [HOST/]OWNER/REPO   Select another repository using the [HOST/]OWNER/REPO format

INHERITED FLAGS
  --help   Show help for command

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

!gh run list
STATUS  TITLE       WORKFLOW   BRANCH     EVENT    ID         ELAPSED  AGE      
βœ“       pages b...  pages-...  gh-pages   dynamic  986951...  27s      about ...
βœ“       D  _pro...  CI         main       push     986950...  2m44s    about ...
βœ“       D  _pro...  Deploy...  main       push     986950...  3m19s    about ...
βœ“       R  nbs/...  CI         test_r...  push     986910...  32s      about ...
βœ“       pages b...  pages-...  gh-pages   dynamic  985771...  29s      about ...
βœ“       R  nbs/...  Deploy...  main       push     985769...  3m37s    about ...
βœ“       R  nbs/...  CI         main       push     985769...  3m0s     about ...
βœ“       pages b...  pages-...  gh-pages   dynamic  980833...  21s      about ...
βœ“       M  nbs/...  CI         main       push     980831...  2m45s    about ...
βœ“       M  nbs/...  Deploy...  main       push     980831...  3m27s    about ...
βœ“       pages b...  pages-...  gh-pages   dynamic  980335...  23s      about ...
βœ“       R  nbs/...  CI         main       push     980334...  2m50s    about ...
βœ“       R  nbs/...  Deploy...  main       push     980334...  3m30s    about ...
βœ“       pages b...  pages-...  gh-pages   dynamic  979506...  24s      about ...
βœ“       A  nbs/...  Deploy...  main       push     979505...  3m14s    about ...
βœ“       A  nbs/...  CI         main       push     979505...  2m53s    about ...
βœ“       pages b...  pages-...  gh-pages   dynamic  979453...  32s      about ...
βœ“       A  nbs/...  CI         main       push     979452...  2m44s    about ...
βœ“       A  nbs/...  Deploy...  main       push     979452...  3m16s    about ...
βœ“       pages b...  pages-...  gh-pages   dynamic  979437...  23s      about ...

Secret

!gh secret
Secrets can be set at the repository, or organization level for use in
GitHub Actions or Dependabot. User, organization, and repository secrets can be set for
use in GitHub Codespaces. Environment secrets can be set for use in
GitHub Actions. Run `gh help secret set` to learn how to get started.


USAGE
  gh secret <command> [flags]

AVAILABLE COMMANDS
  delete:      Delete secrets
  list:        List secrets
  set:         Create or update secrets

FLAGS
  -R, --repo [HOST/]OWNER/REPO   Select another repository using the [HOST/]OWNER/REPO format

INHERITED FLAGS
  --help   Show help for command

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

!gh secret list
NAME         UPDATED          
TEST_SECRET  about 12 days ago

SSH-KEY

!gh ssh-key
Manage SSH keys registered with your GitHub account.

USAGE
  gh ssh-key <command> [flags]

AVAILABLE COMMANDS
  add:         Add an SSH key to your GitHub account
  delete:      Delete an SSH key from your GitHub account
  list:        Lists SSH keys in your GitHub account

INHERITED FLAGS
  --help   Show help for command

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

!gh ssh-key list
TITLE         ID        KEY                    TYPE            ADDED            
thekkel       91043211  ssh-ed255...r/x2XqozE  authentication  about 7 months...
new_main      92029161  ssh-ed255...gm+IHN+ix  authentication  about 6 months...
linux laptop  92203051  ssh-ed255...U7UtGrWSr  authentication  about 6 months...
oracle        97589482  ssh-ed255...GQaF1/TAK  authentication  about 3 months...

Status

!gh status
Assigned Issues                       β”‚ Assigned Pull Requests                
bthek1/flutter_test#2  Webdevelopment β”‚ Nothing here ^_^                      
bthek1/flutter_test#1  App developmentβ”‚                                       
                                      β”‚                                       
Review Requests                       β”‚ Mentions                              
Nothing here ^_^                      β”‚ Nothing here ^_^                      
                                      β”‚                                       
Repository Activity
Nothing here ^_^

Variable

!gh variable
Variables can be set at the repository, environment or organization level for use in
GitHub Actions or Dependabot. Run `gh help variable set` to learn how to get started.
 

USAGE
  gh variable <command> [flags]

AVAILABLE COMMANDS
  delete:      Delete variables
  get:         Get variables
  list:        List variables
  set:         Create or update variables

FLAGS
  -R, --repo [HOST/]OWNER/REPO   Select another repository using the [HOST/]OWNER/REPO format

INHERITED FLAGS
  --help   Show help for command

LEARN MORE
  Use `gh <command> <subcommand> --help` for more information about a command.
  Read the manual at https://cli.github.com/manual

!gh variable list
NAME           VALUE  UPDATED               
TEST_VARIABLE  5      less than a minute ago
Back to top